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

1.12 Release Notes Draft #214

Merged
merged 13 commits into from
Jul 23, 2018

Conversation

marpaia
Copy link
Contributor

@marpaia marpaia commented Jul 2, 2018

I generated these notes using the release-notes tool that I'm working on in kubernetes/release#575. I would like to just continuously re-render these notes until it comes time to give them to the individual SIGs as the release burns down. So if there are any edits that we'd like to structurally incorporate into this document, let's encode it in the code so that we can keep re-applying the same patterns for notes sorting (if possible).

For each note, we have the following information available to use for document organization decision making:

  • The note text itself
  • All the commit info (SHA, author, etc)
  • Labels on the PR (kind/bug, release-note-action-required, sig-node, etc)
  • The PR description and comments

Right now, I'm using all the SIG labels I can find to pre-sort and then using the kind/bug and release-note-action-required label to add the "Bug Fixes" and "Action Required" sections respectively. Everything that doesn't have a SIG label or one of those two labels goes into "Other Notable Changes".

/assign @nickchase

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 2, 2018
@jberkus
Copy link
Contributor

jberkus commented Jul 2, 2018

additional labels to consider, that are sometimes present:

both of the below generally mean an API change or new API, and are likely to be present in addition to other kind/ labels:
kind/api-change
kind/design

Also, the kind/cleanup (or kind/refactor) label is occasionally present for PRs demanding a release note; do we want to do anything special with that?

@marpaia
Copy link
Contributor Author

marpaia commented Jul 2, 2018

Maybe kind/feature for a "New Features" section?

@marpaia
Copy link
Contributor Author

marpaia commented Jul 2, 2018

I added a "New Features" and "API Changes" section but there are none of those so far in 1.12. To get a good feel for what this would look like at the end of a release, take a look at this rendering of the 1.11 release notes.

Ideally "Other Notable Changes" wouldn't have many notes in it and many of these notes are in-fact associated with a SIG, but are just not labeled as such. Fortunately we can go label those PRs post-merge and re-render the release notes to get them sorted, but ideally we could require there is some categorization label applied to PRs which have a release note (ie: some sig/* or kind/* or area/* label).

@marpaia
Copy link
Contributor Author

marpaia commented Jul 2, 2018

I ran some experiments and from 1.10.0 to 1.11.0, the only PRs with release notes that didn't specify a SIG but did specify a kind label other than (and not including) one that would already categorize them (bug, feature, api-change, new-api) are:

So I think sig label and then kind/bug, kind/feature, kind/new-api, and kind/api-change make for a pretty comprehensive set of what is labeled at all. Past that, we can just generate the notes, see what's not labeled, go label it, and regenerate the notes.

@marpaia marpaia force-pushed the 1.12-release-notes-draft branch from 90f7966 to 6e89b08 Compare July 3, 2018 21:59
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 3, 2018
@marpaia
Copy link
Contributor Author

marpaia commented Jul 3, 2018

Can I LGTM my own PR?

/lgtm

@k8s-ci-robot
Copy link
Contributor

@marpaia: you cannot LGTM your own PR.

In response to this:

Can I LGTM my own PR?

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 9, 2018
@nickchase
Copy link
Contributor

OK, I really like what we've got here. One change that I think we need, though, is that "action required" items shouldn't also appear in the sig sections. Other than that, I think this is ready for us to move forward.

@marpaia marpaia changed the title 1.12 Release Notes so far (new tool format proposal) 1.12 Release Notes Draft Jul 17, 2018
@calebamiles
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 23, 2018
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: calebamiles, marpaia

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@calebamiles
Copy link
Contributor

assuming we can consolidate the action required after this PR merges

@k8s-ci-robot k8s-ci-robot merged commit fe17051 into kubernetes:master Jul 23, 2018
@marpaia marpaia deleted the 1.12-release-notes-draft branch July 23, 2018 16:20
@marpaia
Copy link
Contributor Author

marpaia commented Jul 23, 2018

@calebamiles what do you mean? do you want the Action Required section subcategorized by SIG or anything in particular?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants