From addee0699e25f4e3bcc9cbef9c797c08e71765fe Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Thu, 27 Aug 2020 12:05:35 -0400 Subject: [PATCH] quick update to changelog instructins (#71492) --- .../rst/dev_guide/developing_collections.rst | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_collections.rst b/docs/docsite/rst/dev_guide/developing_collections.rst index 3cba1b6bfd1..f7ad370266e 100644 --- a/docs/docsite/rst/dev_guide/developing_collections.rst +++ b/docs/docsite/rst/dev_guide/developing_collections.rst @@ -731,8 +731,6 @@ We recommend that you use the `antsibull-changelog `_ for details. - Understanding antsibull-changelog --------------------------------- @@ -773,6 +771,21 @@ The following changelog fragment categories are consumed by the Ansible changelo * ``deprecated_features`` * ``removed_features`` +Including collection changelogs into Ansible +============================================= + + +If your collection is part of Ansible, use one of the following three options to include your changelog into the Ansible release changelog: + +* Use the ``antsibull-changelog`` tool. + +* If are not using this tool, include the properly formatted ``changelog.yaml`` file into your collection. See the `changlog.yaml format `_ for details. + +* Add a link to own changelogs or release notes in any format by opening an issue at https://github.com/ansible-community/ansible-build-data/ with the HTML link to that information. + +.. note:: + + For the first two options, Ansible pulls the changelog details from Galaxy so your changelogs must be included in the collection version on Galaxy that is included in the upcoming Ansible release. .. seealso::