Introduce release.yml to improve GitHub release notes generation
#213
Conversation
There was a problem hiding this comment.
Given this is about Error Prone WDYT about a dedicated section "New bug checkers and templates" like EP does?
Will we also create a CHANGELOG.md?
.github/release.yml
Outdated
| labels: | ||
| - documentation | ||
| - chores | ||
| - title: ":warning: Dependency Upgrades" |
There was a problem hiding this comment.
Why :warning: for dependency upgrades? I would expect that emoji for the first section on update considerations.
(I would use :broom: or :chart_upwards: here instead then)
|
Thanks for the review @ferdinand-swoboda ! 🚀
Good idea, perhaps we should have two variants,
I used this because we do the same for PSM. Will update to :chart_upwards: 😄.
Yeah I thought about this, but wasn't too sure yet. I can see why this makes sense :).
Not sure for now TBH. It's out of scope for this PR, perhaps we'll add this later. |
There was a problem hiding this comment.
The example looks awesome 🚀
Do we want a single enhancement label or two labels saying new feature and improvement (and perhaps add more)?
If we use refaster template and error prone check do we need new feature and improvement after all? (I think it'd be nice to keep them).
Had interesting chat offline on the topic of splitting refaster templates and error prone checks! I don't see why users would be interested in one or the other. They are technically different but have the same goal and as a user I don't really care how exactly the tool fixes my code as long as it fixes it 🤔
I think we should definitely keep Improvements section, as there will be changes to the existing features.
Do we want the ignore-changelog label?
Generally sounds useful, especially as the release notes grow bigger.
.github/release.yml
Outdated
| categories: | ||
| - title: ":rocket: New Error Prone checks" | ||
| labels: | ||
| - "error prone check" |
There was a problem hiding this comment.
Should this indicate the "new" aspect? Otherwise one could also apply the label to improvement PRs.
There was a problem hiding this comment.
Discussed this with @ibabiankou offline, will propose something new. We think we should make a split between Error Prone checks and Refaster templates.
.github/release.yml
Outdated
| - "error prone check" | ||
| - title: ":sunny: New Refaster templates" | ||
| labels: | ||
| - "refaster template" |
.github/release.yml
Outdated
| - title: ":sparkles: New features and improvements" | ||
| labels: | ||
| - "new feature" | ||
| - improvement |
There was a problem hiding this comment.
Shall we quote all strings for consistency.
.github/release.yml
Outdated
| - deprecation | ||
| - title: ":bug: Bug fixes" | ||
| labels: | ||
| - bug |
There was a problem hiding this comment.
This would suit issues, but not PRs. Maybe add "bug fix" 🤔
.github/release.yml
Outdated
| - title: ":bug: Bug fixes" | ||
| labels: | ||
| - bug | ||
| - title: ":books: Documentation, tests and build" |
There was a problem hiding this comment.
| - title: ":books: Documentation, tests and build" | |
| - title: ":books: Documentation, test and build improvements" |
.github/release.yml
Outdated
| - title: ":books: Documentation, tests and build" | ||
| labels: | ||
| - documentation | ||
| - chores |
There was a problem hiding this comment.
| - chores | |
| - chore |
?
|
Updated the labels and applied suggestions! |
|
Made a tiny tweak, will re-generate the release notes from |
rickie
changed the title
release.yml to improve release notes generationrelease.yml to improve GitHub release notes generation
rickie
added
the
chore
See an overview of the labels here.
The official documentation for automated release notes on GitHub can be found here.
To verify the changes, I updated the base branch and created a tag
v0.2.1and compared it withv0.1.0.This was the output ⏬
What's Changed
✨ New features and improvements
@RequestAttributefromRequestMappingAnnotationcheck by @ddeya in Exempt@RequestAttributefromRequestMappingAnnotationcheck #189ThrowableAssertAlternative#withMessage(String, Object...)expression by @ivan-fedorov in Rewrite anotherThrowableAssertAlternative#withMessage(String, Object...)expression #190NestedOptionalscheck by @Venorcis in IntroduceNestedOptionalscheck #202ImmutablesSortedSetComparatorcheck by @ferdinand-swoboda in IntroduceImmutablesSortedSetComparatorcheck #102com.google.errorprone.matchers.Matchersmethods by @oxkitsune in Require static import ofcom.google.errorprone.matchers.Matchersmethods #201NonEmptyMonocheck by @cernat-catalin in IntroduceNonEmptyMonocheck #200String#valueOfoverObjects#toStringby @Stephan202 in PreferString#valueOfoverObjects#toString#192RxJava2AdapterRefaster templates by @Stephan202 in Fix severalRxJava2AdapterRefaster templates #205📖 Documentation, Tests and Build
VoidMissingNullablecheck by @Stephan202 in Enable Error Prone'sVoidMissingNullablecheck #180StreamMapToOptionalGetRefaster template documentation by @rickie in ImproveStreamMapToOptionalGetRefaster template documentation #203nohttp-checkstyleby @Stephan202 in Enablenohttp-checkstyle#206New Contributors
@RequestAttributefromRequestMappingAnnotationcheck #189NestedOptionalscheck #202ImmutablesSortedSetComparatorcheck #102NonEmptyMonocheck #200Full Changelog: v0.1.0...v0.2.1
Open questions:
enhancementlabel or two labels sayingnew featureandimprovement(and perhaps add more)?refaster templateanderror prone checkdo we neednew featureandimprovementafter all? (I think it'd be nice to keep them).ignore-changeloglabel?Let me know what you think!