diff options
author | Felix Fontein <felix@fontein.de> | 2021-08-23 21:25:45 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-08-23 12:25:45 -0700 |
commit | 9691eb5f2054b2c39a33b3ecb2bdb60c167b590b (patch) | |
tree | e7baf21037b8761cda0b1074c7b795ca699b54af /docs/docsite/rst | |
parent | 5a35a95ceb2904fe6474da3f7c928cd32bf8240f (diff) | |
download | ansible-9691eb5f2054b2c39a33b3ecb2bdb60c167b590b.tar.gz |
Also allow .yml. (#75439) (#75460)
(cherry picked from commit 0055a328b3250b40de5b4027458c51887379b7eb)
Diffstat (limited to 'docs/docsite/rst')
-rw-r--r-- | docs/docsite/rst/community/development_process.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/docsite/rst/community/development_process.rst b/docs/docsite/rst/community/development_process.rst index c227218d0e..b98d4a3711 100644 --- a/docs/docsite/rst/community/development_process.rst +++ b/docs/docsite/rst/community/development_process.rst @@ -167,11 +167,11 @@ We build short summary changelogs for minor releases as well as for major releas Creating a changelog fragment ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -A basic changelog fragment is a ``.yaml`` file placed in the ``changelogs/fragments/`` directory. Each file contains a yaml dict with keys like ``bugfixes`` or ``major_changes`` followed by a list of changelog entries of bugfixes or features. Each changelog entry is rst embedded inside of the yaml file which means that certain constructs would need to be escaped so they can be interpreted by rst and not by yaml (or escaped for both yaml and rst if you prefer). Each PR **must** use a new fragment file rather than adding to an existing one, so we can trace the change back to the PR that introduced it. +A basic changelog fragment is a ``.yaml`` or ``.yml`` file placed in the ``changelogs/fragments/`` directory. Each file contains a yaml dict with keys like ``bugfixes`` or ``major_changes`` followed by a list of changelog entries of bugfixes or features. Each changelog entry is rst embedded inside of the yaml file which means that certain constructs would need to be escaped so they can be interpreted by rst and not by yaml (or escaped for both yaml and rst if you prefer). Each PR **must** use a new fragment file rather than adding to an existing one, so we can trace the change back to the PR that introduced it. PRs which add a new module or plugin do not necessarily need a changelog fragment. See the previous section :ref:`community_changelogs`. Also see the next section :ref:`changelogs_how_to_format` for the precise format changelog fragments should have. -To create a changelog entry, create a new file with a unique name in the ``changelogs/fragments/`` directory of the corresponding repository. The file name should include the PR number and a description of the change. It must end with the file extension ``.yaml``. For example: ``40696-user-backup-shadow-file.yaml`` +To create a changelog entry, create a new file with a unique name in the ``changelogs/fragments/`` directory of the corresponding repository. The file name should include the PR number and a description of the change. It must end with the file extension ``.yaml`` or ``.yml``. For example: ``40696-user-backup-shadow-file.yaml`` A single changelog fragment may contain multiple sections but most will only contain one section. The toplevel keys (bugfixes, major_changes, and so on) are defined in the `config file <https://github.com/ansible/ansible/blob/devel/changelogs/config.yaml>`_ for our `release note tool <https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.rst>`_. Here are the valid sections and a description of each: |