-
Notifications
You must be signed in to change notification settings - Fork 39
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
add changelog builder for release publishing #1377
Merged
Merged
Conversation
This file contains 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
alaviss
force-pushed
the
push-lqswvnxuyprt
branch
from
July 11, 2024 01:51
d8f3794
to
474fb31
Compare
saem
approved these changes
Jul 11, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change itself looks good, for the PR body the summary and details bodies can probably be switched.
Does this look better? |
/merge Let's just go for it |
Merge requested by: @alaviss Contents after the first section break of the PR description has been removed and preserved below:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Add changelog builder to the publishing workflow. This allows us to
provide richer release information to users.
Details
The changelog builder will tally all PRs merged between the previous tag
and the latest tag, then generate a categorized changelog for them. The
configuration for the builder can be found at
.github/changelog.json
.
In addition to this,
/generate-changelog
PR command has been added,which allows maintainers to generate a changelog based on the new
configuration within a given PR.
Usage:
Where:
from
: Specify the previous tag. If not provided, will be the firsttag older than
to
.to
: Specify the latest tag. If not provided, will be the latesttag in this repository.
no_prerelease
: Only applies whenfrom
is not provided. If setto
true
,from
is selected such that the older tag is /not/ apre-release. Defaults to
false
.