Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: changelog sorting options #165

Merged
merged 6 commits into from
Jun 19, 2024

Conversation

gardar
Copy link
Contributor

@gardar gardar commented May 27, 2024

Adds option for sorting entries in changelogs/changelog.yaml by semantic version and in the same order as the Changelog.md/.rst

Before:

0.0.1, 0.0.2, 0.1.0, 0.1.1, 0.1.2, 0.10.0, 0.10.1, 0.10.2, 0.11.1, 0.11.2, 0.2.0, 0.2.1, 0.2.2, 0.3.0

After

0.0.1, 0.0.2, 0.1.0, 0.1.1, 0.1.2, 0.2.0, 0.2.1, 0.2.2, 0.3.0, 0.10.0, 0.10.1, 0.10.2, 0.11.1, 0.11.2

Added this as a configurable option to avoid config rewrites although the current sorting is incorrect in my option.

Signed-off-by: gardar <gardar@users.noreply.github.com>
Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution! Please note that you need to add a changelog fragment.

docs/changelog-configuration.md Outdated Show resolved Hide resolved
src/antsibull_changelog/changes.py Outdated Show resolved Hide resolved
src/antsibull_changelog/changes.py Outdated Show resolved Hide resolved
src/antsibull_changelog/yaml.py Outdated Show resolved Hide resolved
Signed-off-by: gardar <gardar@users.noreply.github.com>
@gardar gardar changed the title minor: add option for sorting changelog entries by semantic version feat: changelog sorting options Jun 15, 2024
Signed-off-by: gardar <gardar@users.noreply.github.com>
src/antsibull_changelog/yaml.py Outdated Show resolved Hide resolved
docs/changelog-configuration.md Outdated Show resolved Hide resolved
changelogs/fragments/165-changelog-sort-option.yml Outdated Show resolved Hide resolved
src/antsibull_changelog/changes.py Outdated Show resolved Hide resolved
@felixfontein
Copy link
Collaborator

There's now a conflict (due to merging #168).

gardar and others added 3 commits June 19, 2024 18:25
Co-authored-by: Felix Fontein <felix@fontein.de>
Signed-off-by: gardar <gardar@users.noreply.github.com>
@felixfontein felixfontein merged commit a4f0f7c into ansible-community:main Jun 19, 2024
4 of 5 checks passed
@felixfontein
Copy link
Collaborator

@gardar thanks a lot for your contribution!

@gardar gardar deleted the semver-sort branch June 19, 2024 18:46
@gardar
Copy link
Contributor Author

gardar commented Jun 19, 2024

My pleasure! Any chance you'll be publishing a new release soon?

@felixfontein
Copy link
Collaborator

Very soon :) I want to add another small feature (reformatting changelogs/changelog.yaml to current settings of the config file) first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants