Release 0.2.0.

ansible-community · Apr 2, 2023 · bd83095 · bd83095
1 parent 479b59c
commit bd83095
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 24 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,38 @@ antsibull-docs -- TypeScript library for processing Ansible documentation markup
 .. contents:: Topics
 
 
+v0.2.0
+======
+
+Release Summary
+---------------
+
+New major release that increases compatibility with the `Python code in antsibull-docs-parser <https://github.com/ansible-community/antsibull-docs-parser>`__.
+
+Minor Changes
+-------------
+
+- Add support for ansible-doc like text output (https://github.com/ansible-community/antsibull-docs-ts/pull/36).
+- Add support for semantic markup in roles (https://github.com/ansible-community/antsibull-docs-ts/pull/31).
+- Allow to add markup source to every paragraph part (https://github.com/ansible-community/antsibull-docs-ts/pull/37).
+- 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-ts/pull/38).
+- Improve error messages by removing superfluous second ``Error:`` (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
+- Make parsing of ``P(...)`` more similar to Python code with respect to error reporting (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- All DOM parts have a new ``source`` property, which must be a string or ``undefined`` (https://github.com/ansible-community/antsibull-docs-ts/pull/37).
+- By default, the error messages now contain the full faulty markup command (https://github.com/ansible-community/antsibull-docs-ts/pull/38).
+- Extend ``OptionNamePart`` and ``ReturnValuePart`` interfaces by adding ``entrypoint`` (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
+- Modify ``pluginOptionLikeLink`` signature to include a new argument ``entrypoint`` after ``plugin`` (https://github.com/ansible-community/antsibull-docs-ts/pull/31).
+- Rename ``only_classic_markup`` parser option to ``onlyClassicMarkup`` (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
+
+Bugfixes
+--------
+
+- HTML and MarkDown code: quote HTML command arguments correctly; make sure URLs are correctly quoted (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
+
 v0.1.0
 ======
 

diff --git a/README.md b/README.md
@@ -105,7 +105,7 @@ to re-format the source files.
 
 1. Update package version in `package.json`.
 2. Create `changelogs/fragments/<version>.yml` with a `release_summary` section.
-3. Run `rm -rf build && npm run build`.
+3. Run `rm -rf dist && npm run build`.
 4. Run `npm publish --dry-run` and check the output.
 5. Run `antsibull-changelog release` and add the updated files to git.
 6. Commit with message `Release <version>.` and run `git tag <version>`.

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -39,3 +39,37 @@ releases:
     - 8-fixes.yml
     - rename.yml
     release_date: '2023-03-13'
+  0.2.0:
+    changes:
+      breaking_changes:
+      - All DOM parts have a new ``source`` property, which must be a string or ``undefined``
+        (https://github.com/ansible-community/antsibull-docs-ts/pull/37).
+      - By default, the error messages now contain the full faulty markup command
+        (https://github.com/ansible-community/antsibull-docs-ts/pull/38).
+      - Extend ``OptionNamePart`` and ``ReturnValuePart`` interfaces by adding ``entrypoint``
+        (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
+      - Modify ``pluginOptionLikeLink`` signature to include a new argument ``entrypoint``
+        after ``plugin`` (https://github.com/ansible-community/antsibull-docs-ts/pull/31).
+      - Rename ``only_classic_markup`` parser option to ``onlyClassicMarkup`` (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
+      bugfixes:
+      - 'HTML and MarkDown code: quote HTML command arguments correctly; make sure
+        URLs are correctly quoted (https://github.com/ansible-community/antsibull-docs-ts/pull/22).'
+      minor_changes:
+      - Add support for ansible-doc like text output (https://github.com/ansible-community/antsibull-docs-ts/pull/36).
+      - Add support for semantic markup in roles (https://github.com/ansible-community/antsibull-docs-ts/pull/31).
+      - Allow to add markup source to every paragraph part (https://github.com/ansible-community/antsibull-docs-ts/pull/37).
+      - 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-ts/pull/38).
+      - Improve error messages by removing superfluous second ``Error:`` (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
+      - Make parsing of ``P(...)`` more similar to Python code with respect to error
+        reporting (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
+      release_summary: New major release that increases compatibility with the `Python
+        code in antsibull-docs-parser <https://github.com/ansible-community/antsibull-docs-parser>`__.
+    fragments:
+    - 0.2.0.yml
+    - 22-python.yml
+    - 31-semantic-markup-roles.yml
+    - 36-ansible-doc-text.yml
+    - 37-source.yml
+    - 38-helpful-errors.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/22-python.yml b/changelogs/fragments/22-python.yml
diff --git a/changelogs/fragments/31-semantic-markup-roles.yml b/changelogs/fragments/31-semantic-markup-roles.yml
diff --git a/changelogs/fragments/36-ansible-doc-text.yml b/changelogs/fragments/36-ansible-doc-text.yml
diff --git a/changelogs/fragments/37-source.yml b/changelogs/fragments/37-source.yml
diff --git a/changelogs/fragments/38-helpful-errors.yml b/changelogs/fragments/38-helpful-errors.yml