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

Add instructions for the release process #346

Merged
merged 4 commits into from
Oct 8, 2020

Conversation

nckturner
Copy link
Contributor

  • Fixes Document release procedure #343
  • Documents the procedure I use for releases
  • Fixes ./hack/changelog.py to prepend the new changelog to the beginning of the existing changelog with the correct formatting.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 8, 2020
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 8, 2020
@nckturner nckturner removed the request for review from christopherhein October 8, 2020 01:43
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 8, 2020
Copy link
Member

@micahhausler micahhausler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for documenting this! Just a few minor changes

docs/RELEASE.md Outdated Show resolved Hide resolved
docs/RELEASE.md Outdated

Bumping a minor version after releasing a new feature:
```
v0.4.5 -> v0.5.0-alpha.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make these examples 1.x.y? Technically v0.x.y are unstable and can have breaking changes at any time.

Separately, its probably worth cutting a v1.0.0 since we're pretty stable

Copy link
Contributor Author

@nckturner nckturner Oct 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fair on both points. We can probably work towards a 1.0 but should have a bit of an issue triage, and make any necessary fixes before cutting it.

docs/RELEASE.md Outdated Show resolved Hide resolved
docs/RELEASE.md Outdated

## Check the release on github

Look at the release that was just published and validate that the release has the appropriate binaries (compare to a previous release). Check the ECR registry to make sure that the images were published. Finally, edit the release text to match previous releases, by copying the changelog text and adding the container image links.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we document what the proper release binaries are?

nckturner and others added 3 commits October 7, 2020 19:06
Co-authored-by: Micah Hausler <micahhausler@users.noreply.github.com>
Co-authored-by: Micah Hausler <micahhausler@users.noreply.github.com>
@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 Oct 8, 2020
Copy link
Member

@micahhausler micahhausler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

Thank you!

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: micahhausler, nckturner

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:
  • OWNERS [micahhausler,nckturner]

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

@k8s-ci-robot k8s-ci-robot merged commit 17dad2d into kubernetes-sigs:master Oct 8, 2020
@melnikalex melnikalex mentioned this pull request Apr 25, 2021
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.

Document release procedure
3 participants