From 4f853c7a790d8390eb2992c3fa5fbe2994b9afc2 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 25 Aug 2024 09:55:59 +0200 Subject: [PATCH] Release 1.1.0. --- CHANGELOG.md | 88 +++++++++++++++--------- CHANGELOG.rst | 22 ++++++ changelogs/changelog.yaml | 20 ++++++ changelogs/fragments/1.1.0.yml | 1 - changelogs/fragments/286-escaping.yml | 3 - changelogs/fragments/295-whitespace.yml | 3 - changelogs/fragments/296-postprocess.yml | 4 -- 7 files changed, 99 insertions(+), 42 deletions(-) delete mode 100644 changelogs/fragments/1.1.0.yml delete mode 100644 changelogs/fragments/286-escaping.yml delete mode 100644 changelogs/fragments/295-whitespace.yml delete mode 100644 changelogs/fragments/296-postprocess.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index 16c35d1..9853045 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,44 +2,70 @@ **Topics** -- v1\.0\.2 +- v1\.1\.0 - Release Summary + - Minor Changes - Bugfixes -- v1\.0\.1 +- v1\.0\.2 - Release Summary - Bugfixes -- v1\.0\.0 +- v1\.0\.1 - Release Summary -- v0\.4\.0 - - Release Summary - - Minor Changes - - Breaking Changes / Porting Guide - Bugfixes -- v0\.3\.0 +- v1\.0\.0 + - Release Summary +- v0\.4\.0 - Release Summary - Minor Changes -- v0\.2\.0 + - Breaking Changes / Porting Guide + - Bugfixes +- v0\.3\.0 - Release Summary - Minor Changes - - Breaking Changes / Porting Guide - - Bugfixes -- v0\.1\.0 +- v0\.2\.0 - Release Summary - Minor Changes - - Breaking Changes / Porting Guide + - Breaking Changes / Porting Guide - Bugfixes -- v0\.0\.1 +- v0\.1\.0 - Release Summary + - Minor Changes + - Breaking Changes / Porting Guide + - Bugfixes +- v0\.0\.1 + - Release Summary + + +## v1\.1\.0 + + +### Release Summary + +Bugfix and feature release that improves markup parsing and generation with respect to whitespace handling and escaping\. + + +### Minor Changes + +* Allow to determine how to handle whitespace during parsing with the new whitespace option \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/295](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/295)\)\. +* Always remove some whitespace around HORIZONTALLINE \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/295](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/295)\)\. +* Apply postprocessing to RST and MarkDown to avoid generating invalid markup when input contains whitespace at potentially dangerous places \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/296](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/296)\)\. + + +### Bugfixes + +* Do not apply URI encoding to visible URL \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/286](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/286)\)\. +* Fix RST escaping to handle other whitespace than spaces correctly \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/296](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/296)\)\. +* Improve handling of empty URL for links \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/286](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/286)\)\. ## v1\.0\.2 - + ### Release Summary Bugfix release\. - + ### Bugfixes * Fix handling of empty markup parameters for RST \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/262](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/262)\)\. @@ -47,12 +73,12 @@ Bugfix release\. ## v1\.0\.1 - + ### Release Summary Maintenance release\. - + ### Bugfixes * Properly escape MarkDown link targets \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/197](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/197)\)\. @@ -60,7 +86,7 @@ Maintenance release\. ## v1\.0\.0 - + ### Release Summary First stable release\. This package is using semantic versioning\, so there will be no more breaking changes until the release of 2\.0\.0\. @@ -68,12 +94,12 @@ First stable release\. This package is using semantic versioning\, so there will ## v0\.4\.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 * Also escape \. in MarkDown \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/51](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/51)\)\. @@ -83,7 +109,7 @@ New major release that increases compatibility with the [Python code in antsibul * Rename current\_plugin options of various functions to currentPlugin\, and the role\_entrypoint option of parse to roleEntrypoint \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/49](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/49)\)\. - + ### Bugfixes * Fix URL escaping in MarkDown \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/51](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/51)\)\. @@ -91,12 +117,12 @@ New major release that increases compatibility with the [Python code in antsibul ## v0\.3\.0 - + ### Release Summary Feature release\. - + ### Minor Changes * Add support for plain RST rendering \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/42](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/42)\)\. @@ -104,12 +130,12 @@ Feature release\. ## 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](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/36)\)\. @@ -128,7 +154,7 @@ New major release that increases compatibility with the [Python code in antsibul * Modify pluginOptionLikeLink signature to include a new argument entrypoint after plugin \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/31](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](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](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/22)\)\. @@ -136,12 +162,12 @@ New major release that increases compatibility with the [Python code in antsibul ## 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](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/1)\)\. @@ -156,7 +182,7 @@ First usable version\, including semantic markup support\. * The package was renamed on npmjs\.com from antsibull\_docs to antsibull\-docs \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/15](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](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/8)\)\. @@ -165,7 +191,7 @@ First usable version\, including semantic markup support\. ## v0\.0\.1 - + ### Release Summary Initial release\. diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 750ea8f..874c4f0 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,28 @@ antsibull-docs -- TypeScript library for processing Ansible documentation markup .. contents:: Topics +v1.1.0 +====== + +Release Summary +--------------- + +Bugfix and feature release that improves markup parsing and generation with respect to whitespace handling and escaping. + +Minor Changes +------------- + +- Allow to determine how to handle whitespace during parsing with the new ``whitespace`` option (https://github.com/ansible-community/antsibull-docs-ts/pull/295). +- Always remove some whitespace around ``HORIZONTALLINE`` (https://github.com/ansible-community/antsibull-docs-ts/pull/295). +- Apply postprocessing to RST and MarkDown to avoid generating invalid markup when input contains whitespace at potentially dangerous places (https://github.com/ansible-community/antsibull-docs-ts/pull/296). + +Bugfixes +-------- + +- Do not apply URI encoding to visible URL (https://github.com/ansible-community/antsibull-docs-ts/pull/286). +- Fix RST escaping to handle other whitespace than spaces correctly (https://github.com/ansible-community/antsibull-docs-ts/pull/296). +- Improve handling of empty URL for links (https://github.com/ansible-community/antsibull-docs-ts/pull/286). + v1.0.2 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 374c689..a5e7394 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -124,3 +124,23 @@ releases: - 1.0.2.yml - 262-rst.yml release_date: '2024-06-30' + 1.1.0: + changes: + bugfixes: + - Do not apply URI encoding to visible URL (https://github.com/ansible-community/antsibull-docs-ts/pull/286). + - Fix RST escaping to handle other whitespace than spaces correctly (https://github.com/ansible-community/antsibull-docs-ts/pull/296). + - Improve handling of empty URL for links (https://github.com/ansible-community/antsibull-docs-ts/pull/286). + minor_changes: + - Allow to determine how to handle whitespace during parsing with the new + ``whitespace`` option (https://github.com/ansible-community/antsibull-docs-ts/pull/295). + - Always remove some whitespace around ``HORIZONTALLINE`` (https://github.com/ansible-community/antsibull-docs-ts/pull/295). + - Apply postprocessing to RST and MarkDown to avoid generating invalid markup + when input contains whitespace at potentially dangerous places (https://github.com/ansible-community/antsibull-docs-ts/pull/296). + release_summary: Bugfix and feature release that improves markup parsing and + generation with respect to whitespace handling and escaping. + fragments: + - 1.1.0.yml + - 286-escaping.yml + - 295-whitespace.yml + - 296-postprocess.yml + release_date: '2024-08-25' diff --git a/changelogs/fragments/1.1.0.yml b/changelogs/fragments/1.1.0.yml deleted file mode 100644 index 17a8598..0000000 --- a/changelogs/fragments/1.1.0.yml +++ /dev/null @@ -1 +0,0 @@ -release_summary: Bugfix and feature release that improves markup parsing and generation with respect to whitespace handling and escaping. diff --git a/changelogs/fragments/286-escaping.yml b/changelogs/fragments/286-escaping.yml deleted file mode 100644 index c594f44..0000000 --- a/changelogs/fragments/286-escaping.yml +++ /dev/null @@ -1,3 +0,0 @@ -bugfixes: - - "Do not apply URI encoding to visible URL (https://github.com/ansible-community/antsibull-docs-ts/pull/286)." - - "Improve handling of empty URL for links (https://github.com/ansible-community/antsibull-docs-ts/pull/286)." diff --git a/changelogs/fragments/295-whitespace.yml b/changelogs/fragments/295-whitespace.yml deleted file mode 100644 index 2007a71..0000000 --- a/changelogs/fragments/295-whitespace.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - "Allow to determine how to handle whitespace during parsing with the new ``whitespace`` option (https://github.com/ansible-community/antsibull-docs-ts/pull/295)." - - "Always remove some whitespace around ``HORIZONTALLINE`` (https://github.com/ansible-community/antsibull-docs-ts/pull/295)." diff --git a/changelogs/fragments/296-postprocess.yml b/changelogs/fragments/296-postprocess.yml deleted file mode 100644 index 719b04b..0000000 --- a/changelogs/fragments/296-postprocess.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: - - "Apply postprocessing to RST and MarkDown to avoid generating invalid markup when input contains whitespace at potentially dangerous places (https://github.com/ansible-community/antsibull-docs-ts/pull/296)." -bugfixes: - - "Fix RST escaping to handle other whitespace than spaces correctly (https://github.com/ansible-community/antsibull-docs-ts/pull/296)."