Skip to content

Commit bd83095

Browse files
committed
Release 0.2.0.
1 parent 479b59c commit bd83095

9 files changed

+67
-24
lines changed

CHANGELOG.rst

+32
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,38 @@ antsibull-docs -- TypeScript library for processing Ansible documentation markup
55
.. contents:: Topics
66

77

8+
v0.2.0
9+
======
10+
11+
Release Summary
12+
---------------
13+
14+
New major release that increases compatibility with the `Python code in antsibull-docs-parser <https://github.com/ansible-community/antsibull-docs-parser>`__.
15+
16+
Minor Changes
17+
-------------
18+
19+
- Add support for ansible-doc like text output (https://github.com/ansible-community/antsibull-docs-ts/pull/36).
20+
- Add support for semantic markup in roles (https://github.com/ansible-community/antsibull-docs-ts/pull/31).
21+
- Allow to add markup source to every paragraph part (https://github.com/ansible-community/antsibull-docs-ts/pull/37).
22+
- 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).
23+
- Improve error messages by removing superfluous second ``Error:`` (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
24+
- Make parsing of ``P(...)`` more similar to Python code with respect to error reporting (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
25+
26+
Breaking Changes / Porting Guide
27+
--------------------------------
28+
29+
- 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).
30+
- By default, the error messages now contain the full faulty markup command (https://github.com/ansible-community/antsibull-docs-ts/pull/38).
31+
- Extend ``OptionNamePart`` and ``ReturnValuePart`` interfaces by adding ``entrypoint`` (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
32+
- Modify ``pluginOptionLikeLink`` signature to include a new argument ``entrypoint`` after ``plugin`` (https://github.com/ansible-community/antsibull-docs-ts/pull/31).
33+
- Rename ``only_classic_markup`` parser option to ``onlyClassicMarkup`` (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
34+
35+
Bugfixes
36+
--------
37+
38+
- 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).
39+
840
v0.1.0
941
======
1042

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ to re-format the source files.
105105

106106
1. Update package version in `package.json`.
107107
2. Create `changelogs/fragments/<version>.yml` with a `release_summary` section.
108-
3. Run `rm -rf build && npm run build`.
108+
3. Run `rm -rf dist && npm run build`.
109109
4. Run `npm publish --dry-run` and check the output.
110110
5. Run `antsibull-changelog release` and add the updated files to git.
111111
6. Commit with message `Release <version>.` and run `git tag <version>`.

changelogs/changelog.yaml

+34
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,37 @@ releases:
3939
- 8-fixes.yml
4040
- rename.yml
4141
release_date: '2023-03-13'
42+
0.2.0:
43+
changes:
44+
breaking_changes:
45+
- All DOM parts have a new ``source`` property, which must be a string or ``undefined``
46+
(https://github.com/ansible-community/antsibull-docs-ts/pull/37).
47+
- By default, the error messages now contain the full faulty markup command
48+
(https://github.com/ansible-community/antsibull-docs-ts/pull/38).
49+
- Extend ``OptionNamePart`` and ``ReturnValuePart`` interfaces by adding ``entrypoint``
50+
(https://github.com/ansible-community/antsibull-docs-parser/pull/9).
51+
- Modify ``pluginOptionLikeLink`` signature to include a new argument ``entrypoint``
52+
after ``plugin`` (https://github.com/ansible-community/antsibull-docs-ts/pull/31).
53+
- Rename ``only_classic_markup`` parser option to ``onlyClassicMarkup`` (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
54+
bugfixes:
55+
- 'HTML and MarkDown code: quote HTML command arguments correctly; make sure
56+
URLs are correctly quoted (https://github.com/ansible-community/antsibull-docs-ts/pull/22).'
57+
minor_changes:
58+
- Add support for ansible-doc like text output (https://github.com/ansible-community/antsibull-docs-ts/pull/36).
59+
- Add support for semantic markup in roles (https://github.com/ansible-community/antsibull-docs-ts/pull/31).
60+
- Allow to add markup source to every paragraph part (https://github.com/ansible-community/antsibull-docs-ts/pull/37).
61+
- Can switch between error messages containing a shortened version of the faulty
62+
markup or the full faulty markup command (https://github.com/ansible-community/antsibull-docs-ts/pull/38).
63+
- Improve error messages by removing superfluous second ``Error:`` (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
64+
- Make parsing of ``P(...)`` more similar to Python code with respect to error
65+
reporting (https://github.com/ansible-community/antsibull-docs-ts/pull/22).
66+
release_summary: New major release that increases compatibility with the `Python
67+
code in antsibull-docs-parser <https://github.com/ansible-community/antsibull-docs-parser>`__.
68+
fragments:
69+
- 0.2.0.yml
70+
- 22-python.yml
71+
- 31-semantic-markup-roles.yml
72+
- 36-ansible-doc-text.yml
73+
- 37-source.yml
74+
- 38-helpful-errors.yml
75+
release_date: '2023-04-02'

changelogs/fragments/0.2.0.yml

-1
This file was deleted.

changelogs/fragments/22-python.yml

-7
This file was deleted.

changelogs/fragments/31-semantic-markup-roles.yml

-5
This file was deleted.

changelogs/fragments/36-ansible-doc-text.yml

-2
This file was deleted.

changelogs/fragments/37-source.yml

-4
This file was deleted.

changelogs/fragments/38-helpful-errors.yml

-4
This file was deleted.

0 commit comments

Comments
 (0)