|
| 1 | +# https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to |
| 2 | + |
| 3 | +bugfixes: |
| 4 | + - "Agent role - Fix delegation of activation in handler." |
| 5 | + |
| 6 | +minor_changes: |
| 7 | + - "Agent role - Make forcing of foreign changes on activation by handler configurable." |
| 8 | + |
| 9 | +## Line Format |
| 10 | + |
| 11 | +# When writing a changelog entry, use the following format: |
| 12 | + |
| 13 | +# - scope - description starting with a uppercase letter and ending with a period at the very end. Multiple sentences are allowed. |
| 14 | + |
| 15 | +# The scope is usually a module or plugin name or group of modules or plugins, for example, lookup plugins. While module names can (and should) be mentioned directly (foo_module), plugin names should always be followed by the type (foo inventory plugin). |
| 16 | + |
| 17 | +# For changes that are not really scoped (for example, which affect a whole collection), use the following format: |
| 18 | + |
| 19 | +# - Description starting with an uppercase letter and ending with a dot at the very end. Multiple sentences are allowed. |
| 20 | + |
| 21 | + |
| 22 | +## Possible keys: |
| 23 | + |
| 24 | +# release_summary |
| 25 | +# Not sure, what it does at this point, will need to test. Needs to be a single line, no list! |
| 26 | + |
| 27 | +# breaking_changes |
| 28 | + |
| 29 | +# Changes that break existing playbooks or roles. This includes any change to existing behavior that forces users to update tasks. Displayed in both the changelogs and the Porting Guides. |
| 30 | +# major_changes |
| 31 | + |
| 32 | +# Major changes to Ansible itself. Generally does not include module or plugin changes. Displayed in both the changelogs and the Porting Guides. |
| 33 | +# minor_changes |
| 34 | + |
| 35 | +# Minor changes to Ansible, modules, or plugins. This includes new features, new parameters added to modules, or behavior changes to existing parameters. |
| 36 | +# deprecated_features |
| 37 | + |
| 38 | +# Features that have been deprecated and are scheduled for removal in a future release. Displayed in both the changelogs and the Porting Guides. |
| 39 | +# removed_features |
| 40 | + |
| 41 | +# Features that were previously deprecated and are now removed. Displayed in both the changelogs and the Porting Guides. |
| 42 | +# security_fixes |
| 43 | + |
| 44 | +# Fixes that address CVEs or resolve security concerns. Include links to CVE information. |
| 45 | +# bugfixes |
| 46 | + |
| 47 | +# Fixes that resolve issues. |
| 48 | +# known_issues |
| 49 | + |
| 50 | +# Known issues that are currently not fixed or will not be fixed. |
0 commit comments