Add release.yml #343
Merged
Add release.yml #343
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
Gsantomaggio
approved these changes
Jul 29, 2024
|
Yes, sure. We just need to merge this PR (this file works only if it is on the main branch) and label all the PRs since the last tag. Then, it should work. |
|
@hiimjako feel free to do the next release :) ! |
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.
Added the
.github/release.ymlfile to generate automatically release notes when creating a new release. More info here.How it Works:
When creating a new release, by clicking the
Generate release notesbutton will automatically fetch and categorize all the merged PRs between the latest tag and the new one, based on the labels in the PRs.If multiple valid labels are present in a PR, it will choose the one with the highest priority, which is determined by the order they appear in the release.yml file.
If a PR contains the label
ignore-for-releaseit will be skipped regardless of the other labels.To benefit this feature, each PR should have at least one label from the list to be included in the auto-generation process. I can add a CI action to ensure that each PR has at least one and only one label, but I think it might be more annoying than useful. What do you think?
Also, can you give me your opinion about the categories and titles? Thanks