Skip to content
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

Merged
merged 1 commit into from
Jun 13, 2019

Conversation

kailuowang
Copy link
Contributor

@kailuowang kailuowang commented Jun 6, 2019

fixes #2879

There are some minor review process clarifications here as well.
namely from

When fixing typos or improving documentation only one sign-off is
required (although for major edits waiting for two may be preferable).

to

When fixing typos, improving documentation or minor build fix only 
one sign-off is required (although for major edits waiting for two
 may be preferable).

@codecov-io
Copy link

codecov-io commented Jun 6, 2019

Codecov Report

Merging #2881 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f59a9b0...41eb08b. Read the comment docs.


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`.
Copy link
Contributor

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.

Copy link
Contributor Author

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.

@travisbrown
Copy link
Contributor

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.

Copy link
Member

@djspiewak djspiewak left a 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.

@kailuowang
Copy link
Contributor Author

@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.

Copy link
Member

@rossabaker rossabaker left a 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.

@djspiewak djspiewak merged commit 341e1b1 into typelevel:master Jun 13, 2019
@kailuowang kailuowang added this to the 2.0.0-RC1 milestone Aug 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update release guideline
6 participants