Skip to content

Commit

Permalink
release documentation - add antsibull-changelog command and fix fragm…
Browse files Browse the repository at this point in the history
…ent location (#1413)

release documentation - add antsibull-changelog command and fix fragment location

SUMMARY
Running through community.aws 5.3.0 I noticed some minor mistakes
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
docs/docsite/rst/collection_release.rst
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis
  • Loading branch information
tremble authored Mar 7, 2023
1 parent fe5a71f commit 980f156
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/docsite/rst/collection_release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ While not strictly necessary it's preferable to add a release summary that will
changelog. For example, the `release summary for 5.2.0
<https://ansible-collections.github.io/amazon.aws/branch/stable-5/collections/amazon/aws/docsite/CHANGELOG.html#release-summary>`_

**changelog/fragments/release-summary.yml:**
**changelogs/fragments/release-summary.yml:**

.. code-block:: yaml
Expand All @@ -254,6 +254,10 @@ Generate the merged changelog
Next we need to generate the merged changelog. This will automatically delete the used fragments,
update ``CHANGELOG.rst``, ``changelogs/changelog.yaml``, and ``git add`` what it changes.

.. code-block:: bash
antsibull-changelog release
Commit all of these changes to your local branch.

Create your Pull Request
Expand Down

0 comments on commit 980f156

Please sign in to comment.