Skip to content

Commit 57069e3

Browse files
committed
Add changelogs.
1 parent 78f2b38 commit 57069e3

File tree

5 files changed

+131
-11
lines changed

5 files changed

+131
-11
lines changed

changelogs/changelog.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ releases:
186186
- 'Agent role - Add explicit "become: false" to the "Discover services and labels
187187
on host." task.'
188188
- Downtime module - Fix handling of parameters start_after and end_after.
189-
release_summary: Bugfix Release
189+
release_summary: Bugfix Release.
190190
fragments:
191191
- agent.yml
192192
- downtime.yml

changelogs/fragments/agent.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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.

changelogs/fragments/release.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
release_summary: "Collected bugfixes."
2+
3+
minor_changes:
4+
- "contact_group module - Fix Ansible Galaxy linting findings."
5+
- "discovery module - Fix Ansible Galaxy linting findings."
6+
- "downtime module - Fix Ansible Galaxy linting findings."
7+
- "host_group module - Fix Ansible Galaxy linting findings."
8+
- "rule module - Fix Ansible Galaxy linting findings."
9+
- "service_group module - Fix Ansible Galaxy linting findings."

changelogs/fragments/rule.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to
2+
3+
minor_changes:
4+
- "Rule module - Improve rule comparison logic. No dummy rule is necessary for comparison anymore."
5+
6+
## Line Format
7+
8+
# When writing a changelog entry, use the following format:
9+
10+
# - scope - description starting with a uppercase letter and ending with a period at the very end. Multiple sentences are allowed.
11+
12+
# 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).
13+
14+
# For changes that are not really scoped (for example, which affect a whole collection), use the following format:
15+
16+
# - Description starting with an uppercase letter and ending with a dot at the very end. Multiple sentences are allowed.
17+
18+
19+
## Possible keys:
20+
21+
# release_summary
22+
# Not sure, what it does at this point, will need to test. Needs to be a single line, no list!
23+
24+
# breaking_changes
25+
26+
# 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.
27+
# major_changes
28+
29+
# Major changes to Ansible itself. Generally does not include module or plugin changes. Displayed in both the changelogs and the Porting Guides.
30+
# minor_changes
31+
32+
# Minor changes to Ansible, modules, or plugins. This includes new features, new parameters added to modules, or behavior changes to existing parameters.
33+
# deprecated_features
34+
35+
# Features that have been deprecated and are scheduled for removal in a future release. Displayed in both the changelogs and the Porting Guides.
36+
# removed_features
37+
38+
# Features that were previously deprecated and are now removed. Displayed in both the changelogs and the Porting Guides.
39+
# security_fixes
40+
41+
# Fixes that address CVEs or resolve security concerns. Include links to CVE information.
42+
# bugfixes
43+
44+
# Fixes that resolve issues.
45+
# known_issues
46+
47+
# Known issues that are currently not fixed or will not be fixed.

changelogs/template.yml

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
1-
# https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to
1+
###########################################################
2+
# #
3+
# Please use this template when writing changelogs. #
4+
# Remove all comment lines, once you added your changes. #
5+
# Refer to the archive, if you need examples. #
6+
# #
7+
###########################################################
28

3-
## Line Format
9+
10+
#
11+
## Line Format:
12+
#
413

514
# When writing a changelog entry, use the following format:
615

@@ -13,29 +22,34 @@
1322
# - Description starting with an uppercase letter and ending with a dot at the very end. Multiple sentences are allowed.
1423

1524

25+
#
1626
## Possible keys:
27+
#
28+
# release_summary
29+
# Adds a single line release summary to the changelog.
1730

1831
# breaking_changes
19-
2032
# 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.
21-
# major_changes
2233

34+
# major_changes
2335
# Major changes to Ansible itself. Generally does not include module or plugin changes. Displayed in both the changelogs and the Porting Guides.
24-
# minor_changes
2536

37+
# minor_changes
2638
# Minor changes to Ansible, modules, or plugins. This includes new features, new parameters added to modules, or behavior changes to existing parameters.
27-
# deprecated_features
2839

40+
# deprecated_features
2941
# Features that have been deprecated and are scheduled for removal in a future release. Displayed in both the changelogs and the Porting Guides.
30-
# removed_features
3142

43+
# removed_features
3244
# Features that were previously deprecated and are now removed. Displayed in both the changelogs and the Porting Guides.
33-
# security_fixes
3445

46+
# security_fixes
3547
# Fixes that address CVEs or resolve security concerns. Include links to CVE information.
36-
# bugfixes
3748

49+
# bugfixes
3850
# Fixes that resolve issues.
39-
# known_issues
4051

52+
# known_issues
4153
# Known issues that are currently not fixed or will not be fixed.
54+
55+
# Reference: https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to

0 commit comments

Comments
 (0)