-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
improve process document and release notes script #2881
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2881 +/- ##
=======================================
Coverage 94.21% 94.21%
=======================================
Files 368 368
Lines 6948 6948
Branches 308 308
=======================================
Hits 6546 6546
Misses 402 402 Continue to review full report at Codecov.
|
|
||
3. For PRs that add no value to the code or documentation or build, for example, community announcements or additions to adopter list, we do not include them in the release notes. Assign these PRs a special milestone: `Excluded from release notes` | ||
|
||
4. Assign the rest PRs with the target milestone and one or more of the following labels: `testing`, `bug`, `build`, `documentation`, `enhancement`, `Source Breaking` and `Binary Breaking`. |
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.
Is it too late to be consistent about case for labels? I know it's silly but looking at this list is extremely painful to me.
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.
IIRC, it's easy to change label text retrospectively. However, the intention for the case choice for breaking-change labels is for them to stand out as they often deserve more attention from users. We used color as well but there are users that are color blinded.
I'm vaguely 👎 on this. I don't think releases happen often enough to need all this automation, and would rather have hand-written release notes that can provide some synthesis, emphasis, etc. On a pettier note I'm also still 👎 on the inconsistently-cased labels. If everyone else wants to approve it, go for it, but I'd rather not. |
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.
I'm 👍 on all of this except for the inconsistent label casing. I'd prefer if everything were just entirely lower-case.
@travisbrown on your first objection, I would like to clarify that this process does not automatically publish the release note. The release note script merely generates a draft and the maintainer still have to copy paste and edit, if necessary, it. The process also makes the history of PRs on GitHub a lot more organized and searchable through milestones and labels. |
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.
I'm fine with it. I agree with Travis on hand tweaking, and I don't want to ever badger new contributors for pristine titles on PRs to support pristine automated changelogs. But it's also tedious to assemble them after the fact, so I appreciate the tools to get a baseline.
The inconsistent casing also makes me cringe, but I won't stand in the way of progress over it.
fixes #2879
There are some minor review process clarifications here as well.
namely from
to