Release 0.2.0.

ansible-community · Apr 2, 2023 · 6f7f224 · 6f7f224
1 parent 21f6d3a
commit 6f7f224
Show file tree

Hide file tree

Showing 9 changed files with 57 additions and 24 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,33 @@ antsibull-docs-parser -- Python library for processing Ansible documentation mar
 .. contents:: Topics
 
 
+v0.2.0
+======
+
+Release Summary
+---------------
+
+New major release that increases compatibility with the `TypeScript code in antsibull-docs-ts <https://github.com/ansible-community/antsibull-docs-ts>`__.
+
+Minor Changes
+-------------
+
+- Add strict mode for parsing (https://github.com/ansible-community/antsibull-docs-parser/pull/15).
+- Add support for ansible-doc like text output (https://github.com/ansible-community/antsibull-docs-parser/pull/17).
+- Add support for semantic markup in roles (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
+- Allow to add markup source to every paragraph part (https://github.com/ansible-community/antsibull-docs-parser/pull/18).
+- Can switch between error messages containing a shortened version of the faulty markup or the full faulty markup command (https://github.com/ansible-community/antsibull-docs-parser/pull/19).
+- Create script to update/extend the test vectors automatically (https://github.com/ansible-community/antsibull-docs-parser/pull/16).
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- All DOM named tuples now have a ``source`` entry before ``type`` (https://github.com/ansible-community/antsibull-docs-parser/pull/18).
+- By default, the error messages now contain the full faulty markup command (https://github.com/ansible-community/antsibull-docs-parser/pull/19).
+- Extend ``OptionNamePart`` and ``ReturnValuePart`` named tuples by adding ``entrypoint`` after ``plugin`` (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
+- Modify ``LinkProvider.plugin_option_like_link`` signature to include a new argument ``entrypoint`` after ``plugin`` (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
+- ``CommandParser.parse`` has a new ``source`` parameter (https://github.com/ansible-community/antsibull-docs-parser/pull/18).
+
 v0.0.1
 ======
 

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -6,3 +6,33 @@ releases:
  fragments:
  - 0.0.1.yml
  release_date: '2023-03-21'
+ 0.2.0:
+ changes:
+ breaking_changes:
+ - All DOM named tuples now have a ``source`` entry before ``type`` (https://github.com/ansible-community/antsibull-docs-parser/pull/18).
+ - By default, the error messages now contain the full faulty markup command
+ (https://github.com/ansible-community/antsibull-docs-parser/pull/19).
+ - Extend ``OptionNamePart`` and ``ReturnValuePart`` named tuples by adding ``entrypoint``
+ after ``plugin`` (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
+ - Modify ``LinkProvider.plugin_option_like_link`` signature to include a new
+ argument ``entrypoint`` after ``plugin`` (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
+ - '``CommandParser.parse`` has a new ``source`` parameter (https://github.com/ansible-community/antsibull-docs-parser/pull/18).'
+ minor_changes:
+ - Add strict mode for parsing (https://github.com/ansible-community/antsibull-docs-parser/pull/15).
+ - Add support for ansible-doc like text output (https://github.com/ansible-community/antsibull-docs-parser/pull/17).
+ - Add support for semantic markup in roles (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
+ - Allow to add markup source to every paragraph part (https://github.com/ansible-community/antsibull-docs-parser/pull/18).
+ - Can switch between error messages containing a shortened version of the faulty
+ markup or the full faulty markup command (https://github.com/ansible-community/antsibull-docs-parser/pull/19).
+ - Create script to update/extend the test vectors automatically (https://github.com/ansible-community/antsibull-docs-parser/pull/16).
+ release_summary: New major release that increases compatibility with the `TypeScript
+ code in antsibull-docs-ts <https://github.com/ansible-community/antsibull-docs-ts>`__.
+ fragments:
+ - 0.2.0.yml
+ - 15-lint.yml
+ - 16-create-vectors.yml
+ - 17-ansible-doc-text.yml
+ - 18-source.yml
+ - 19-helpful-errors.yml
+ - 9-semantic-markup-roles.yml
+ release_date: '2023-04-02'
diff --git a/changelogs/fragments/0.2.0.yml b/changelogs/fragments/0.2.0.yml
diff --git a/changelogs/fragments/15-lint.yml b/changelogs/fragments/15-lint.yml
diff --git a/changelogs/fragments/16-create-vectors.yml b/changelogs/fragments/16-create-vectors.yml
diff --git a/changelogs/fragments/17-ansible-doc-text.yml b/changelogs/fragments/17-ansible-doc-text.yml
diff --git a/changelogs/fragments/18-source.yml b/changelogs/fragments/18-source.yml
diff --git a/changelogs/fragments/19-helpful-errors.yml b/changelogs/fragments/19-helpful-errors.yml
diff --git a/changelogs/fragments/9-semantic-markup-roles.yml b/changelogs/fragments/9-semantic-markup-roles.yml