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

Enable release notes automation #142

Closed
jsafrane opened this issue Apr 10, 2019 · 11 comments · Fixed by kubernetes-csi/csi-release-tools#54
Closed

Enable release notes automation #142

jsafrane opened this issue Apr 10, 2019 · 11 comments · Fixed by kubernetes-csi/csi-release-tools#54
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@jsafrane
Copy link
Contributor

It's hard to keep track of changes between releases and compose correct CHANGELOG.

Proposal:

  • Add PR template to all kubernetes-csi repos. Template of the template: Add PR template external-attacher#139. It's slightly trimmed version of kubernetes/kubernetes template with removed links to Kubernetes specific docs.

  • Enable release-notes bot in prow that will nag people to fill ```release-note (same as in kubernetes/kubernetes).

  • PR reviewers/approvers must ensure that ```release-note is filled in PRs where is makes sense.

  • Use release-notes tool to generate CHANGELOG from ```release-note, ```release-note Action required: and /kind {feature|bug} in PRs. See Kubernetes 1.11 - we won't get SIG sections, but the rest should be similar. Some manual editing is still required (deprecations?).

@kubernetes-csi/csi-misc

@saad-ali
Copy link
Member

Seems like a great idea

@msau42
Copy link
Collaborator

msau42 commented Jun 7, 2019

Here's one sample invocation:

./release-notes --start-sha=0ed6978fd199e3ca10326b82b4b8b8e916211c9b --end-sha=3cb3d2f18ed8cb40371c6d8886edcabd1f27e7b9 --github-org=kubernetes-csi --github-repo=external-attacher -branch=master -output out.md

Would be nice to potentially add something like this into our release tools repo and have it pick up from a particular tag.

@msau42
Copy link
Collaborator

msau42 commented Jun 7, 2019

/help

@k8s-ci-robot
Copy link
Contributor

@msau42:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

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 the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Jun 7, 2019
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 5, 2019
@msau42
Copy link
Collaborator

msau42 commented Sep 5, 2019

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 5, 2019
@jsafrane
Copy link
Contributor Author

What's remaining to be done? cluster-driver-registrar is deprecated and the other repos have a PR template.

@msau42
Copy link
Collaborator

msau42 commented Sep 10, 2019

I think having a script in csi-release-tools to generate the params to the tool would be nice

@msau42
Copy link
Collaborator

msau42 commented Sep 20, 2019

Something doesn't seem right right the release tool generator. When I ran:

release-notes --start-sha=0bee749334d32e9e07cce2aaa90bbdba9a12d04a --end-sha=a1a8f48aa47c3eb63d108f4245b88d243601a90e --github-org=kubernetes-csi --github-repo=external-provisioner -branch=master -output out.md

it picked up a bunch of release notes from commits that we already released in 1.3.0

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 19, 2019
@davidz627
Copy link
Contributor

This seems mostly resolved. I believe the remaining work is to make this more automated with a script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants