changelog: categorize changelog entry using labels #4474
Conversation
With this change, release-drafter will be able to categorically write/create changelogs based on the labels.
| categories: | ||
| - title: "🚀 New Features and Enhancements " | ||
| labels: | ||
| - "feature" |
There was a problem hiding this comment.
Could also start using labels with emojis.
| @@ -1,5 +1,48 @@ | |||
| # Config for https://github.com/apps/release-drafter | |||
| branches: | |||
| - master | |||
| name-template: "$RESOLVED_VERSION 🦉 " | |||
There was a problem hiding this comment.
Previously, it'd generate draft releases with "Draft" title. Now, it can automatically resolve versions. To auto-increment, slap a "minor"/"major"/"patch" labels on PR and it'll auto-increment after merge.
There was a problem hiding this comment.
| name-template: "$RESOLVED_VERSION 🦉 " | |
| name-template: "$RESOLVED_VERSION 🦉" |
(minor whitespace :P)
I also noticed a lot of whitespaces for other titles - is this to support potential suffixes like "minor/major?" Surely the suffix should add the space?
There was a problem hiding this comment.
Mostly a copy-paste issue with one that I was playing with on my private repo. 😄 We can leave it for now.
skshetry
moved this from In progress
to Review in progress
in DVC 25 August - 8 September 2020
|
@pared, yes, we do need some labels. Let me track it here.
|
|
Okay, moving ahead with this. We can always change the labels or the "texts". |
|
|
||
| Thanks again to $CONTRIBUTORS for the contributions! 🎉 |
There was a problem hiding this comment.
weird to @mention everyone again a second time. waste of a line?
There was a problem hiding this comment.
Nope, I don't think it's enough to thank people for their contributions. Maybe add another line too? 😜
There was a problem hiding this comment.
Anyway, they don't get notifications, so should be fine, I guess.
There was a problem hiding this comment.
to be clear, each issue/PR changelog entry already has the person @mentioned, which is already more than most changelogs do and is also arguably besides the point of a changelog. Having another line at the bottom mentioning everyone again is pointless. At that stage, yes, you may as well really add another line soliciting additional contributions and linking to https://dvc.org/doc/user-guide/contributing/core
With this change, release-drafter will be able to categorically
write/create changelogs based on the labels.
Check this release which was generated by same config: https://github.com/skshetry/dvc/releases/tag/1.2.4
Fixes #4023
❗ I have followed the Contributing to DVC checklist.
📖 If this PR requires documentation updates, I have created a separate PR (or issue, at least) in dvc.org and linked it here.
Thank you for the contribution - we'll try to review it as soon as possible. 🙏