Enable release notes automation

Question

Enable release notes automation

jsafrane opened this issue 6 years ago · 11 comments

jsafrane commented 6 years ago

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: kubernetes-csi/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

msau42 commented 5 years ago

/help

Answer 1 · 2019-04-18T23:54:02.000Z

Seems like a great idea

Answer 2 · 2019-06-07T16:38:16.000Z

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.

Answer 3 · 2019-06-07T16:38:27.000Z

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

Answer 4 · 2019-09-05T17:26:08.000Z

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

Answer 5 · 2019-09-05T23:22:49.000Z

/remove-lifecycle stale

Answer 6 · 2019-09-10T13:49:54.000Z

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

Answer 7 · 2019-09-10T14:04:37.000Z

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

Answer 8 · 2019-09-20T01:28:48.000Z

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

Answer 9 · 2019-12-19T02:10:51.000Z

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

Answer 10 · 2019-12-20T23:54:33.000Z

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