Release 0.1.0.

ansible-community · Mar 13, 2023 · 5bc13a2 · 5bc13a2
1 parent c4c1d6a
commit 5bc13a2
Show file tree

Hide file tree

Showing 11 changed files with 62 additions and 18 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,35 @@ antsibull-docs -- TypeScript library for processing Ansible documentation markup
 .. contents:: Topics
 
 
+v0.1.0
+======
+
+Release Summary
+---------------
+
+First usable version, including semantic markup support.
+
+Minor Changes
+-------------
+
+- Add support for semantic markup (https://github.com/ansible-community/antsibull-docs-ts/pull/1).
+- Added MarkDown support (https://github.com/ansible-community/antsibull-docs-ts/pull/5).
+- Allow to adjust formatting for HTML, RST, and MarkDown output by allowing to provide formatting functions for every part type (https://github.com/ansible-community/antsibull-docs-ts/pull/12).
+- Allow to chose between antsibull-docs like formatting (for Sphinx targets) and plain formatting for HTML (https://github.com/ansible-community/antsibull-docs-ts/pull/12).
+- Build both ESM and CommonJS modules for easier consumption in both webpack and node.js projects (https://github.com/ansible-community/antsibull-docs-ts/pull/14).
+- Mention paragraph number in error messages when not processing single strings (https://github.com/ansible-community/antsibull-docs-ts/pull/11).
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- The package was renamed on npmjs.com from ``antsibull_docs`` to ``antsibull-docs`` (https://github.com/ansible-community/antsibull-docs-ts/pull/15).
+
+Bugfixes
+--------
+
+- Fix error message output for MarkDown. Make sure error message is escaped in RST. Fix error messages when parsing escaped parameters (https://github.com/ansible-community/antsibull-docs-ts/pull/8).
+- The ``parse()`` option ``errors``'s default was ``exception``, and not ``message`` as documented. The default is now ``message`` (https://github.com/ansible-community/antsibull-docs-ts/pull/6).
+
 v0.0.1
 ======
 

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -6,3 +6,36 @@ releases:
     fragments:
     - initial-release.yml
     release_date: '2023-03-07'
+  0.1.0:
+    changes:
+      breaking_changes:
+      - The package was renamed on npmjs.com from ``antsibull_docs`` to ``antsibull-docs``
+        (https://github.com/ansible-community/antsibull-docs-ts/pull/15).
+      bugfixes:
+      - Fix error message output for MarkDown. Make sure error message is escaped
+        in RST. Fix error messages when parsing escaped parameters (https://github.com/ansible-community/antsibull-docs-ts/pull/8).
+      - The ``parse()`` option ``errors``'s default was ``exception``, and not ``message``
+        as documented. The default is now ``message`` (https://github.com/ansible-community/antsibull-docs-ts/pull/6).
+      minor_changes:
+      - Add support for semantic markup (https://github.com/ansible-community/antsibull-docs-ts/pull/1).
+      - Added MarkDown support (https://github.com/ansible-community/antsibull-docs-ts/pull/5).
+      - Allow to adjust formatting for HTML, RST, and MarkDown output by allowing
+        to provide formatting functions for every part type (https://github.com/ansible-community/antsibull-docs-ts/pull/12).
+      - Allow to chose between antsibull-docs like formatting (for Sphinx targets)
+        and plain formatting for HTML (https://github.com/ansible-community/antsibull-docs-ts/pull/12).
+      - Build both ESM and CommonJS modules for easier consumption in both webpack
+        and node.js projects (https://github.com/ansible-community/antsibull-docs-ts/pull/14).
+      - Mention paragraph number in error messages when not processing single strings
+        (https://github.com/ansible-community/antsibull-docs-ts/pull/11).
+      release_summary: First usable version, including semantic markup support.
+    fragments:
+    - 0.1.0.yml
+    - 1-semantic-markup.yml
+    - 11-errors.yml
+    - 12-formatting.yml
+    - 14-module.yml
+    - 5-md.yml
+    - 6-bugs.yml
+    - 8-fixes.yml
+    - rename.yml
+    release_date: '2023-03-13'
diff --git a/changelogs/fragments/0.1.0.yml b/changelogs/fragments/0.1.0.yml
diff --git a/changelogs/fragments/1-semantic-markup.yml b/changelogs/fragments/1-semantic-markup.yml
diff --git a/changelogs/fragments/11-errors.yml b/changelogs/fragments/11-errors.yml
diff --git a/changelogs/fragments/12-formatting.yml b/changelogs/fragments/12-formatting.yml
diff --git a/changelogs/fragments/14-module.yml b/changelogs/fragments/14-module.yml
diff --git a/changelogs/fragments/5-md.yml b/changelogs/fragments/5-md.yml
diff --git a/changelogs/fragments/6-bugs.yml b/changelogs/fragments/6-bugs.yml
diff --git a/changelogs/fragments/8-fixes.yml b/changelogs/fragments/8-fixes.yml
diff --git a/changelogs/fragments/rename.yml b/changelogs/fragments/rename.yml