diff options
author | Mark Chappell <mchappel@redhat.com> | 2022-11-22 20:54:19 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-11-22 14:54:19 -0500 |
commit | 3cc95d1f126e239aa0e357c0060b18a8c4946e7a (patch) | |
tree | 9c252ed212e360a8e022434485fd8ee1f06ad380 | |
parent | 493ef4a559362d874b22d362fe3423a4410c6f70 (diff) | |
download | ansible-3cc95d1f126e239aa0e357c0060b18a8c4946e7a.tar.gz |
docs - make the existence of 'trivial' changelog entries easier to find (#79440)
-rw-r--r-- | docs/docsite/rst/community/collection_development_process.rst | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/docsite/rst/community/collection_development_process.rst b/docs/docsite/rst/community/collection_development_process.rst index 2da3964925..3c2f609cce 100644 --- a/docs/docsite/rst/community/collection_development_process.rst +++ b/docs/docsite/rst/community/collection_development_process.rst @@ -151,10 +151,19 @@ A single changelog fragment may contain multiple sections but most will only con - idrac_user - module may error out with the message ``unable to perform the import or export operation`` because there are pending attribute changes or a configuration job is in progress. Wait for the job to complete and run the task again.(https://github.com/dell/dellemc-openmanage-ansible-modules/pull/303). +**trivial** + Changes where a formal release changelog entry isn't required. ``trivial`` changelog fragments are excluded from the published changelog output and may be used for changes such as housekeeping, documentation and test only changes. + You can use ``trivial`` for collections that require a changelog fragment for each pull request. + + .. code-block:: yaml + + trivial: + - aws_ec2 - fix broken integration test (https://github.com/ansible-collections/amazon.aws/pull/1269). + Each changelog entry must contain a link to its issue between parentheses at the end. If there is no corresponding issue, the entry must contain a link to the PR itself. -Most changelog entries are ``bugfixes`` or ``minor_changes``. You can also use ``trivial`` for any collection that requires a changelog fragment for each pull request. ``trivial`` changelog fragments are excluded from the changelog output. +Most changelog entries are ``bugfixes`` or ``minor_changes``. Changelog fragment entry format |