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

Track features that needs to be a part of release notes #23070

Closed
vishh opened this issue Mar 16, 2016 · 3 comments
Closed

Track features that needs to be a part of release notes #23070

vishh opened this issue Mar 16, 2016 · 3 comments
Assignees
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done.

Comments

@vishh
Copy link
Contributor

vishh commented Mar 16, 2016

Currently, PRs having release-note label is automatically included as part of the release notes. This process does not work for big features though.
We need to track issues that represent features as well and include a gist from those issues in the release notes.

@vishh vishh added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. area/release-eng Issues or PRs related to the Release Engineering subproject labels Mar 16, 2016
@bgrant0607
Copy link
Member

From email to kubernetes-dev:

One thing that was clear is that most people didn't know what should go into the release notes. In a number of cases, I had to ask specific people to add specific items to specific sections. The only way I could do that is I knew what was in the release and how the release notes should be organized.

We need a template for release notes, guidelines for what belongs in release notes, and an example set of release notes (1.2.0).

We also need to capture items that belong in release notes before the PRs merge.

David M. has a proposal to automate release-note collection. We need to extend it with the categories we've created and require every PR assign a category (including something like release-note/none-minor-fix) before being merged by the submit queue. PRs that belong in the release notes will need to have extractable release note text in their PR descriptions.

Writing release notes should be added to the documented developer workflow.

k8s-github-robot pushed a commit that referenced this issue Mar 30, 2016
Automatic merge from submit-queue

Release Notes proposal

Get the conversation started.
cc @eparis @vishh @davidopp @thockin @dchen1107 
Ref #23070
@david-mcmahon
Copy link
Contributor

For now the workaround here is to ensure that the first PR that enables a feature contain the appropriate release-note-* label. https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/release-notes.md#caveats--considerations

@david-mcmahon david-mcmahon added priority/backlog Higher priority than priority/awaiting-more-evidence. priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. and removed priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. priority/backlog Higher priority than priority/awaiting-more-evidence. labels Apr 6, 2016
@david-mcmahon
Copy link
Contributor

Closing. Moved to release repo.

xingzhou pushed a commit to xingzhou/kubernetes that referenced this issue Dec 15, 2016
Automatic merge from submit-queue

Release Notes proposal

Get the conversation started.
cc @eparis @vishh @davidopp @thockin @dchen1107 
Ref kubernetes#23070
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done.
Projects
None yet
Development

No branches or pull requests

3 participants