chore: use github tooling to build release notes#710
chore: use github tooling to build release notes#710psschwei wants to merge 2 commits intogenerative-computing:mainfrom
Conversation
Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
jakelorocco
left a comment
jakelorocco
left a comment
There was a problem hiding this comment.
Do you have an example of what the generated one would look like for v0.4.0? Or if it won't look proper since we didn't do all the labels, is there a good reference somewhere?
I tried generating locally but I guess I don't have the github cli set up correctly.
| const labelMap = { | ||
| 'feat': 'enhancement', | ||
| 'fix': 'bug', | ||
| 'docs': 'documentation', | ||
| 'test': 'testing', | ||
| 'perf': 'enhancement', | ||
| 'refactor': 'enhancement', | ||
| 'ci': 'integrations', | ||
| 'chore': null, | ||
| 'build': null, | ||
| 'style': null, | ||
| }; |
There was a problem hiding this comment.
Our current mergify rule is contains: fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release. Do we need to do anything special for the revert tag? I don't see it listed here.
There was a problem hiding this comment.
PRs that don't have a label would end up in an uncategorized liast at the end... I'll add it with a null entry (similar to chore/build/style)
| if (!match) return; | ||
|
|
||
| const prefix = match[1]; | ||
| const label = labelMap[prefix]; | ||
| if (!label) return; |
There was a problem hiding this comment.
To clarify, an early return here just means that the PR doesn't get a label? This will never stop a PR from being opened / processed?
There was a problem hiding this comment.
yes, that's correct : no impact to PR creation, it just wouldn't have a label
Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>
2 participants
Misc PR
Type of PR
Description
Uses github native tooling to create release notes instead of semantic-version
Also adds auto-labeling for PRs (which is needed for GH to categorize PR for the notes)
Benefit is we'll get a list of contributors in the release notes, and it also calls out first time contributors (which is nice for community building)
If we want to keep the current way we do it, that's fine too.
Testing