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

Improve release changelogs #117

Merged
merged 6 commits into from
Jan 4, 2024
Merged

Conversation

bkchr
Copy link
Contributor

@bkchr bkchr commented Dec 8, 2023

This improves the release by only adding the relevant parts of the CHANGELOG.md file. Besides that it also adds information on how to reproduce the build with srtool.

Closes: #66

bkchr and others added 2 commits December 9, 2023 00:13
This improves the release by only adding the relevant parts of the
CHANGELOG.md file. Besides that it also adds information on how to
reproduce the build with srtool.

Closes: #66
@bkchr bkchr requested a review from ggwpez December 8, 2023 23:24
@bkchr bkchr mentioned this pull request Dec 11, 2023
Copy link
Contributor

@joepetrowski joepetrowski left a comment

Choose a reason for hiding this comment

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

One naming suggestion but still OK as it is.

Comment on lines 30 to 32
"--print-changelog-until-previous-version",
dest="changelog_until_previous",
help="Print the entire changelog until the previous version.",
Copy link
Contributor

Choose a reason for hiding this comment

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

It doesn't really make sense to say "until" something in the past, but I see what you mean that the CHANGELOG file itself goes backwards in time. IMO --print-changelog-from-last-release expresses this better.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My naming is always shit :D

.github/changelog-processor.py Outdated Show resolved Hide resolved
.github/changelog-processor.py Outdated Show resolved Hide resolved
.github/changelog-processor.py Outdated Show resolved Hide resolved
.github/changelog-processor.py Outdated Show resolved Hide resolved
.github/changelog-processor.py Outdated Show resolved Hide resolved
.github/workflows/release.yml Outdated Show resolved Hide resolved
.github/changelog-processor.py Show resolved Hide resolved
.github/workflows/release.yml Show resolved Hide resolved
.github/workflows/release.yml Show resolved Hide resolved
@bkchr
Copy link
Contributor Author

bkchr commented Jan 4, 2024

/merge

@fellowship-merge-bot
Copy link
Contributor

Enabled auto-merge in Pull Request

Available commands
  • /merge: Enables auto-merge for Pull Request
  • /merge cancel: Cancels auto-merge for Pull Request
  • /merge help: Shows this menu

For more information see the documentation

@fellowship-merge-bot fellowship-merge-bot bot enabled auto-merge (squash) January 4, 2024 18:56
@fellowship-merge-bot fellowship-merge-bot bot merged commit ce1ed26 into main Jan 4, 2024
13 checks passed
@ggwpez ggwpez deleted the bkchr-release-changelogs branch January 4, 2024 20:08
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.

Improve release changelogs
6 participants