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.

Sign up for GitHub

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

Jump to bottom

[BUG] CHANGELOG not in semver sorted order #2655

Closed
embano1 opened this issue Nov 11, 2021 · 0 comments · Fixed by #2656
Closed

[BUG] CHANGELOG not in semver sorted order #2655

embano1 opened this issue Nov 11, 2021 · 0 comments · Fixed by #2656

Comments

@embano1
Copy link
Contributor

embano1 commented Nov 11, 2021

The current CHANGELOG.md is not in semver sorted order. This breaks the changelog generator, e.g. when a cherry-pick is made and tags sorted by date (default) are not in ascending order, e.g. as happened between the releases v0.24.2 and v0.27.1.

$ git tag --sort=creatordate
...
v0.26.0
v0.26.1
v0.27.0
v0.24.2
v0.27.1

Correct:

$ git tag --sort=v:refname
...
v0.25.0
v0.26.0
v0.26.1
v0.27.0
v0.27.1

Proposed solution: generate CHANGELOG.md in semver order which requires to drop non-semver compliant tags, e.g. test and all the prerelease-* ones, e.g. prerelease-v0.22.1-247-g770fcba2.
@embano1 embano1 mentioned this issue Nov 11, 2021
Closed
embano1 pushed a commit to embano1/govmomi that referenced this issue Nov 11, 2021
fix: CHANGELOG sorting and generation
1ba2a89 
The CHANGELOG.md is now sorted in semver order, i.e. v0.24.2 will be
sorted before v0.25.0 and not before v0.27.1 as before. This fixes
cherry-picks and is more intuitive for the reader. Also, only
semver-compliant tags are included. This is to work around a bug in
git-chlog and also drop any non-semver compliant tags from the log

Closes: vmware#2638 vmware#2655
Signed-off-by: Michael Gasch <mgasch@vmware.com>
@embano1 embano1 mentioned this issue Nov 11, 2021
Merged
12 tasks
embano1 pushed a commit to embano1/govmomi that referenced this issue Nov 11, 2021
fix: CHANGELOG sorting and generation
10fec66 
The CHANGELOG.md is now sorted in semver order, i.e. v0.24.2 will be
sorted before v0.25.0 and not before v0.27.1 as before. This fixes
cherry-picks and is more intuitive for the reader. Also, only
semver-compliant tags are included. This is to work around a bug in
git-chlog and also drop any non-semver compliant tags from the log

Closes: vmware#2638 vmware#2655
Signed-off-by: Michael Gasch <mgasch@vmware.com>
@embano1 embano1 linked a pull request Nov 11, 2021 that will close this issue
fix: CHANGELOG sorting and generation #2656
Merged
12 tasks
yuyin002 pushed a commit to yuyin002/govmomi that referenced this issue Jan 12, 2022
fix: CHANGELOG sorting and generation
251ee74 
The CHANGELOG.md is now sorted in semver order, i.e. v0.24.2 will be
sorted before v0.25.0 and not before v0.27.1 as before. This fixes
cherry-picks and is more intuitive for the reader. Also, only
semver-compliant tags are included. This is to work around a bug in
git-chlog and also drop any non-semver compliant tags from the log

Closes: vmware#2638 vmware#2655
Signed-off-by: Michael Gasch <mgasch@vmware.com>
pradeep288 pushed a commit to pradeep288/govmomi that referenced this issue Jan 17, 2022
fix: CHANGELOG sorting and generation
8457099 
The CHANGELOG.md is now sorted in semver order, i.e. v0.24.2 will be
sorted before v0.25.0 and not before v0.27.1 as before. This fixes
cherry-picks and is more intuitive for the reader. Also, only
semver-compliant tags are included. This is to work around a bug in
git-chlog and also drop any non-semver compliant tags from the log

Closes: vmware#2638 vmware#2655
Signed-off-by: Michael Gasch <mgasch@vmware.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: CHANGELOG sorting and generation embano1/govmomi
1 participant
@embano1