Add a changelog

.github/workflows/antsibull-lint-tests.yml

@@ -36,10 +36,18 @@ jobs:
         run: |
           coverage run -p --source antsibull -m antsibull.cli.antsibull_lint collection-docs community.general
 
-      - name: antsibull-lint changelog-yaml
+      - name: antsibull-lint changelog-yaml (community.general changelog)
         run: |
           coverage run -p --source antsibull -m antsibull.cli.antsibull_lint changelog-yaml community.general/changelogs/changelog.yaml
 
+      - name: antsibull-lint changelog-yaml (own changelog)
+        run: |
+          coverage run -p --source antsibull -m antsibull.cli.antsibull_lint changelog-yaml changelogs/changelog.yaml
+
+      - name: Lint changelog fragments
+        run: |
+          antsibull-changelog lint
+
       - name: Combine and upload coverage stats
         run: |
           coverage combine .coverage.*

CHANGELOG.rst

@@ -0,0 +1,181 @@
+================================================
+antsibull -- Ansible Build Scripts Release Notes
+================================================
+
+.. contents:: Topics
+
+
+v0.39.2
+=======
+
+Release Summary
+---------------
+
+* Fixes an incompatibility with antsibull-lint with Python 3.9.8.
+* Improves and extends the Ansible build role and its tests.
+
+
+v0.39.1
+=======
+
+Release Summary
+---------------
+
+* Fixes ``M(...)`` when used in HTML blobs.
+* Improve wait on HTTP retries.
+
+
+v0.39.0
+=======
+
+Release Summary
+---------------
+
+Docs generation:
+
+* Improve boilerplate for ansible.builtin documentation
+* Render ``choices`` in return value documentation
+* Add alternating background colors to option and return value tables
+
+Also improves the Ansible release playbook/role.
+
+
+v0.38.2
+=======
+
+Release Summary
+---------------
+
+Avoid creating role documentation for roles without argument spec. Avoid naming collision with Ansible Sphinx config's ``rst_epilog`` contents.
+
+v0.38.1
+=======
+
+Release Summary
+---------------
+
+Fix for attributes support: also allow new support value ``N/A``.
+
+v0.38.0
+=======
+
+Release Summary
+---------------
+
+Support CLI options for the ansible.builtin.ssh connection plugin, and support ansible-core 2.12 module/plugin attributes.
+
+v0.37.0
+=======
+
+v0.36.0
+=======
+
+v0.35.0
+=======
+
+v0.34.0
+=======
+
+v0.33.0
+=======
+
+v0.32.0
+=======
+
+v0.31.0
+=======
+
+v0.30.0
+=======
+
+v0.29.0
+=======
+
+v0.28.0
+=======
+
+v0.27.0
+=======
+
+v0.26.0
+=======
+
+v0.25.0
+=======
+
+v0.24.0
+=======
+
+v0.23.0
+=======
+
+v0.22.0
+=======
+
+v0.21.0
+=======
+
+v0.20.0
+=======
+
+v0.19.0
+=======
+
+v0.18.0
+=======
+
+v0.17.0
+=======
+
+v0.16.0
+=======
+
+v0.15.0
+=======
+
+v0.14.0
+=======
+
+v0.13.0
+=======
+
+v0.12.0
+=======
+
+v0.11.0
+=======
+
+v0.10.0
+=======
+
+v0.9.0
+======
+
+v0.8.0
+======
+
+v0.7.0
+======
+
+v0.6.0
+======
+
+v0.5.0
+======
+
+v0.4.0
+======
+
+v0.3.0
+======
+
+v0.2.0
+======
+
+v0.1.0
+======
+
+Release Summary
+---------------
+
+Initial release.

README.md

@@ -29,6 +29,8 @@ a checkout, you'll have to run them under poetry::
     use pkg_resources which can slow down startup time (in some environments by
     quite a large amount).
 
+You can find a list of changes in [the Antsibull changelog](./CHANGELOG.rst).
+
 Unless otherwise noted in the code, it is licensed under the terms of the GNU
 General Public License v3 or, at your option, later.
 
@@ -68,6 +70,10 @@ npm install -g autoprefixer cssnano postcss postcss-cli
 
 If you want to create a new release::
 
+    vim changelogs/fragment/$VERSION_NUMBER.yml  # create 'release_summary:' fragment
+    antsibull-changelog release --version $VERSION_NUMBER
+    git add CHANGELOG.rst changelogs
+    git commit -m "Release $VERSION_NUMBER."
     poetry build
     poetry publish  # Uploads to pypi.  Be sure you really want to do this
 

changelogs/changelog.yaml

@@ -0,0 +1,125 @@
+ancestor: null
+releases:
+  0.1.0:
+    changes:
+      release_summary: Initial release.
+    release_date: '2020-05-26'
+  0.10.0:
+    release_date: '2020-06-26'
+  0.11.0:
+    release_date: '2020-06-27'
+  0.12.0:
+    release_date: '2020-07-05'
+  0.13.0:
+    release_date: '2020-07-08'
+  0.14.0:
+    release_date: '2020-07-08'
+  0.15.0:
+    release_date: '2020-07-09'
+  0.16.0:
+    release_date: '2020-07-10'
+  0.17.0:
+    release_date: '2020-07-23'
+  0.18.0:
+    release_date: '2020-07-27'
+  0.19.0:
+    release_date: '2020-08-03'
+  0.2.0:
+    release_date: '2020-05-26'
+  0.20.0:
+    release_date: '2020-08-14'
+  0.21.0:
+    release_date: '2020-08-14'
+  0.22.0:
+    release_date: '2020-09-29'
+  0.23.0:
+    release_date: '2020-11-03'
+  0.24.0:
+    release_date: '2020-11-23'
+  0.25.0:
+    release_date: '2020-11-30'
+  0.26.0:
+    release_date: '2021-02-09'
+  0.27.0:
+    release_date: '2021-02-17'
+  0.28.0:
+    release_date: '2021-03-16'
+  0.29.0:
+    release_date: '2021-03-23'
+  0.3.0:
+    release_date: '2020-05-29'
+  0.30.0:
+    release_date: '2021-03-30'
+  0.31.0:
+    release_date: '2021-05-11'
+  0.32.0:
+    release_date: '2021-05-25'
+  0.33.0:
+    release_date: '2021-06-01'
+  0.34.0:
+    release_date: '2021-06-22'
+  0.35.0:
+    release_date: '2021-06-06'
+  0.36.0:
+    release_date: '2021-07-12'
+  0.37.0:
+    release_date: '2021-08-11'
+  0.38.0:
+    changes:
+      release_summary: Support CLI options for the ansible.builtin.ssh connection
+        plugin, and support ansible-core 2.12 module/plugin attributes.
+    release_date: '2021-09-25'
+  0.38.1:
+    changes:
+      release_summary: 'Fix for attributes support: also allow new support value ``N/A``.'
+    release_date: '2021-09-26'
+  0.38.2:
+    changes:
+      release_summary: Avoid creating role documentation for roles without argument
+        spec. Avoid naming collision with Ansible Sphinx config's ``rst_epilog`` contents.
+    release_date: '2021-09-27'
+  0.39.0:
+    changes:
+      release_summary: 'Docs generation:
+
+
+        * Improve boilerplate for ansible.builtin documentation
+
+        * Render ``choices`` in return value documentation
+
+        * Add alternating background colors to option and return value tables
+
+
+        Also improves the Ansible release playbook/role.
+
+        '
+    release_date: '2021-11-01'
+  0.39.1:
+    changes:
+      release_summary: '* Fixes ``M(...)`` when used in HTML blobs.
+
+        * Improve wait on HTTP retries.
+
+        '
+    release_date: '2021-11-09'
+  0.39.2:
+    changes:
+      release_summary: '* Fixes an incompatibility with antsibull-lint with Python
+        3.9.8.
+
+        * Improves and extends the Ansible build role and its tests.
+
+        '
+    release_date: '2021-11-10'
+  0.4.0:
+    release_date: '2020-06-01'
+  0.5.0:
+    release_date: '2020-06-02'
+  0.6.0:
+    release_date: '2020-06-03'
+  0.7.0:
+    release_date: '2020-06-04'
+  0.8.0:
+    release_date: '2020-06-08'
+  0.9.0:
+    release_date: '2020-06-18'

changelogs/config.yaml

@@ -0,0 +1,30 @@
+changelog_filename_template: ../CHANGELOG.rst
+changelog_filename_version_depth: 0
+changes_file: changelog.yaml
+changes_format: combined
+is_other_project: true
+keep_fragments: false
+mention_ancestor: true
+new_plugins_after_name: removed_features
+notesdir: fragments
+prelude_section_name: release_summary
+prelude_section_title: Release Summary
+sections:
+- - major_changes
+  - Major Changes
+- - minor_changes
+  - Minor Changes
+- - breaking_changes
+  - Breaking Changes / Porting Guide
+- - deprecated_features
+  - Deprecated Features
+- - removed_features
+  - Removed Features (previously deprecated)
+- - security_fixes
+  - Security Fixes
+- - bugfixes
+  - Bugfixes
+- - known_issues
+  - Known Issues
+use_semantic_versioning: true
+title: antsibull -- Ansible Build Scripts