collection: Cleanup the changelog(s)#980
Merged
Merged
Conversation
In this commit, the file changelogs/changelog.yml is being reformatted to comply with the standards as published in https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.md and https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelog.yaml-format.md . The command: ``` antsibull-changelog lint-changelog-yaml changelogs/changelog.yaml ``` returns with return code 0. The command: ``` antsibull-changelog generate ``` generates the file CHANGELOG.rst from file changelogs/changelog.yaml. The file CHANGELOG.rst is also part of this commit. Signed-off-by: Bernd Finger <bfinger@redhat.com>
marcelmamula
approved these changes
Feb 18, 2025
Contributor
marcelmamula
left a comment
marcelmamula
left a comment
There was a problem hiding this comment.
LGTM. It looks so much cleaner and dictionary use is way to go.
This was referenced Feb 18, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In this commit, the file
changelogs/changelog.ymlis being reformatted, to comply with the standards as published inhttps://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.md and
https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelog.yaml-format.md .
The command:
returns with return code 0.
The command:
generates the file
CHANGELOG.rstfrom filechangelogs/changelog.yaml. The fileCHANGELOG.rstis also part of this commit.Note: The subsections under
changes:reflect the semver versioning scheme and try to follow the section descriptions in https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.md. So there are only major changes when the first part of the version changes, and only minor changes when the second part of the version changes. If only the third part of the version changes, no minor changes will be mentioned in the changelog.Certain minor changes could as well have been marked as major changes (thus justifying a major release), or certain bugfixes could as well have been minor changes or features (thus justifying a minor release).
Fixes issue #503.