From 5bc13a25d3e2228441bc6efd73ba65fccf301299 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Mon, 13 Mar 2023 22:20:33 +0100 Subject: [PATCH] Release 0.1.0. --- CHANGELOG.rst | 29 +++++++++++++++++++ changelogs/changelog.yaml | 33 ++++++++++++++++++++++ changelogs/fragments/0.1.0.yml | 1 - changelogs/fragments/1-semantic-markup.yml | 2 -- changelogs/fragments/11-errors.yml | 2 -- changelogs/fragments/12-formatting.yml | 3 -- changelogs/fragments/14-module.yml | 2 -- changelogs/fragments/5-md.yml | 2 -- changelogs/fragments/6-bugs.yml | 2 -- changelogs/fragments/8-fixes.yml | 2 -- changelogs/fragments/rename.yml | 2 -- 11 files changed, 62 insertions(+), 18 deletions(-) delete mode 100644 changelogs/fragments/0.1.0.yml delete mode 100644 changelogs/fragments/1-semantic-markup.yml delete mode 100644 changelogs/fragments/11-errors.yml delete mode 100644 changelogs/fragments/12-formatting.yml delete mode 100644 changelogs/fragments/14-module.yml delete mode 100644 changelogs/fragments/5-md.yml delete mode 100644 changelogs/fragments/6-bugs.yml delete mode 100644 changelogs/fragments/8-fixes.yml delete mode 100644 changelogs/fragments/rename.yml diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a46a751..71aedde 100644 --- 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 index 954c28d..246e839 100644 --- 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 deleted file mode 100644 index e31030b..0000000 --- a/changelogs/fragments/0.1.0.yml +++ /dev/null @@ -1 +0,0 @@ -release_summary: First usable version, including semantic markup support. diff --git a/changelogs/fragments/1-semantic-markup.yml b/changelogs/fragments/1-semantic-markup.yml deleted file mode 100644 index b76c319..0000000 --- a/changelogs/fragments/1-semantic-markup.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - "Add support for semantic markup (https://github.com/ansible-community/antsibull-docs-ts/pull/1)." diff --git a/changelogs/fragments/11-errors.yml b/changelogs/fragments/11-errors.yml deleted file mode 100644 index ebb0cc6..0000000 --- a/changelogs/fragments/11-errors.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - "Mention paragraph number in error messages when not processing single strings (https://github.com/ansible-community/antsibull-docs-ts/pull/11)." diff --git a/changelogs/fragments/12-formatting.yml b/changelogs/fragments/12-formatting.yml deleted file mode 100644 index e7b4314..0000000 --- a/changelogs/fragments/12-formatting.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - "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)." diff --git a/changelogs/fragments/14-module.yml b/changelogs/fragments/14-module.yml deleted file mode 100644 index 718e9cc..0000000 --- a/changelogs/fragments/14-module.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - "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)." diff --git a/changelogs/fragments/5-md.yml b/changelogs/fragments/5-md.yml deleted file mode 100644 index 32ad445..0000000 --- a/changelogs/fragments/5-md.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - "Added MarkDown support (https://github.com/ansible-community/antsibull-docs-ts/pull/5)." diff --git a/changelogs/fragments/6-bugs.yml b/changelogs/fragments/6-bugs.yml deleted file mode 100644 index b235e7d..0000000 --- a/changelogs/fragments/6-bugs.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - "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)." diff --git a/changelogs/fragments/8-fixes.yml b/changelogs/fragments/8-fixes.yml deleted file mode 100644 index 7f03422..0000000 --- a/changelogs/fragments/8-fixes.yml +++ /dev/null @@ -1,2 +0,0 @@ -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)." diff --git a/changelogs/fragments/rename.yml b/changelogs/fragments/rename.yml deleted file mode 100644 index 7c13958..0000000 --- a/changelogs/fragments/rename.yml +++ /dev/null @@ -1,2 +0,0 @@ -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)." \ No newline at end of file