Skip to content

Commit

Permalink
Release 1.1.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfontein committed Aug 25, 2024
1 parent 186d10b commit 4f853c7
Show file tree
Hide file tree
Showing 7 changed files with 99 additions and 42 deletions.
88 changes: 57 additions & 31 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,78 +2,104 @@

**Topics**

- <a href="#v1-0-2">v1\.0\.2</a>
- <a href="#v1-1-0">v1\.1\.0</a>
- <a href="#release-summary">Release Summary</a>
- <a href="#minor-changes">Minor Changes</a>
- <a href="#bugfixes">Bugfixes</a>
- <a href="#v1-0-1">v1\.0\.1</a>
- <a href="#v1-0-2">v1\.0\.2</a>
- <a href="#release-summary-1">Release Summary</a>
- <a href="#bugfixes-1">Bugfixes</a>
- <a href="#v1-0-0">v1\.0\.0</a>
- <a href="#v1-0-1">v1\.0\.1</a>
- <a href="#release-summary-2">Release Summary</a>
- <a href="#v0-4-0">v0\.4\.0</a>
- <a href="#release-summary-3">Release Summary</a>
- <a href="#minor-changes">Minor Changes</a>
- <a href="#breaking-changes--porting-guide">Breaking Changes / Porting Guide</a>
- <a href="#bugfixes-2">Bugfixes</a>
- <a href="#v0-3-0">v0\.3\.0</a>
- <a href="#v1-0-0">v1\.0\.0</a>
- <a href="#release-summary-3">Release Summary</a>
- <a href="#v0-4-0">v0\.4\.0</a>
- <a href="#release-summary-4">Release Summary</a>
- <a href="#minor-changes-1">Minor Changes</a>
- <a href="#v0-2-0">v0\.2\.0</a>
- <a href="#breaking-changes--porting-guide">Breaking Changes / Porting Guide</a>
- <a href="#bugfixes-3">Bugfixes</a>
- <a href="#v0-3-0">v0\.3\.0</a>
- <a href="#release-summary-5">Release Summary</a>
- <a href="#minor-changes-2">Minor Changes</a>
- <a href="#breaking-changes--porting-guide-1">Breaking Changes / Porting Guide</a>
- <a href="#bugfixes-3">Bugfixes</a>
- <a href="#v0-1-0">v0\.1\.0</a>
- <a href="#v0-2-0">v0\.2\.0</a>
- <a href="#release-summary-6">Release Summary</a>
- <a href="#minor-changes-3">Minor Changes</a>
- <a href="#breaking-changes--porting-guide-2">Breaking Changes / Porting Guide</a>
- <a href="#breaking-changes--porting-guide-1">Breaking Changes / Porting Guide</a>
- <a href="#bugfixes-4">Bugfixes</a>
- <a href="#v0-0-1">v0\.0\.1</a>
- <a href="#v0-1-0">v0\.1\.0</a>
- <a href="#release-summary-7">Release Summary</a>
- <a href="#minor-changes-4">Minor Changes</a>
- <a href="#breaking-changes--porting-guide-2">Breaking Changes / Porting Guide</a>
- <a href="#bugfixes-5">Bugfixes</a>
- <a href="#v0-0-1">v0\.0\.1</a>
- <a href="#release-summary-8">Release Summary</a>

<a id="v1-1-0"></a>
## v1\.1\.0

<a id="release-summary"></a>
### Release Summary

Bugfix and feature release that improves markup parsing and generation with respect to whitespace handling and escaping\.

<a id="minor-changes"></a>
### Minor Changes

* Allow to determine how to handle whitespace during parsing with the new <code>whitespace</code> 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 <code>HORIZONTALLINE</code> \([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)\)\.

<a id="bugfixes"></a>
### 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)\)\.

<a id="v1-0-2"></a>
## v1\.0\.2

<a id="release-summary"></a>
<a id="release-summary-1"></a>
### Release Summary

Bugfix release\.

<a id="bugfixes"></a>
<a id="bugfixes-1"></a>
### 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)\)\.

<a id="v1-0-1"></a>
## v1\.0\.1

<a id="release-summary-1"></a>
<a id="release-summary-2"></a>
### Release Summary

Maintenance release\.

<a id="bugfixes-1"></a>
<a id="bugfixes-2"></a>
### 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)\)\.

<a id="v1-0-0"></a>
## v1\.0\.0

<a id="release-summary-2"></a>
<a id="release-summary-3"></a>
### 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\.

<a id="v0-4-0"></a>
## v0\.4\.0

<a id="release-summary-3"></a>
<a id="release-summary-4"></a>
### Release Summary

New major release that increases compatibility with the [Python code in antsibull\-docs\-parser](https\://github\.com/ansible\-community/antsibull\-docs\-parser)\.

<a id="minor-changes"></a>
<a id="minor-changes-1"></a>
### Minor Changes

* Also escape <code>\.</code> in MarkDown \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/51](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/51)\)\.
Expand All @@ -83,33 +109,33 @@ New major release that increases compatibility with the [Python code in antsibul

* Rename <code>current\_plugin</code> options of various functions to <code>currentPlugin</code>\, and the <code>role\_entrypoint</code> option of <code>parse</code> to <code>roleEntrypoint</code> \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/49](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/49)\)\.

<a id="bugfixes-2"></a>
<a id="bugfixes-3"></a>
### 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)\)\.

<a id="v0-3-0"></a>
## v0\.3\.0

<a id="release-summary-4"></a>
<a id="release-summary-5"></a>
### Release Summary

Feature release\.

<a id="minor-changes-1"></a>
<a id="minor-changes-2"></a>
### 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)\)\.

<a id="v0-2-0"></a>
## v0\.2\.0

<a id="release-summary-5"></a>
<a id="release-summary-6"></a>
### Release Summary

New major release that increases compatibility with the [Python code in antsibull\-docs\-parser](https\://github\.com/ansible\-community/antsibull\-docs\-parser)\.

<a id="minor-changes-2"></a>
<a id="minor-changes-3"></a>
### 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)\)\.
Expand All @@ -128,20 +154,20 @@ New major release that increases compatibility with the [Python code in antsibul
* Modify <code>pluginOptionLikeLink</code> signature to include a new argument <code>entrypoint</code> after <code>plugin</code> \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/31](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/31)\)\.
* Rename <code>only\_classic\_markup</code> parser option to <code>onlyClassicMarkup</code> \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/22](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/22)\)\.

<a id="bugfixes-3"></a>
<a id="bugfixes-4"></a>
### 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)\)\.

<a id="v0-1-0"></a>
## v0\.1\.0

<a id="release-summary-6"></a>
<a id="release-summary-7"></a>
### Release Summary

First usable version\, including semantic markup support\.

<a id="minor-changes-3"></a>
<a id="minor-changes-4"></a>
### 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)\)\.
Expand All @@ -156,7 +182,7 @@ First usable version\, including semantic markup support\.

* The package was renamed on npmjs\.com from <code>antsibull\_docs</code> to <code>antsibull\-docs</code> \([https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/15](https\://github\.com/ansible\-community/antsibull\-docs\-ts/pull/15)\)\.

<a id="bugfixes-4"></a>
<a id="bugfixes-5"></a>
### 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)\)\.
Expand All @@ -165,7 +191,7 @@ First usable version\, including semantic markup support\.
<a id="v0-0-1"></a>
## v0\.0\.1

<a id="release-summary-7"></a>
<a id="release-summary-8"></a>
### Release Summary

Initial release\.
22 changes: 22 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
======

Expand Down
20 changes: 20 additions & 0 deletions changelogs/changelog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
1 change: 0 additions & 1 deletion changelogs/fragments/1.1.0.yml

This file was deleted.

3 changes: 0 additions & 3 deletions changelogs/fragments/286-escaping.yml

This file was deleted.

3 changes: 0 additions & 3 deletions changelogs/fragments/295-whitespace.yml

This file was deleted.

4 changes: 0 additions & 4 deletions changelogs/fragments/296-postprocess.yml

This file was deleted.

0 comments on commit 4f853c7

Please sign in to comment.