-
Notifications
You must be signed in to change notification settings - Fork 423
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
Add instructions for the release process #346
Conversation
There was a problem hiding this 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
|
||
Bumping a minor version after releasing a new feature: | ||
``` | ||
v0.4.5 -> v0.5.0-alpha.0 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
|
||
## 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. |
There was a problem hiding this comment.
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?
Co-authored-by: Micah Hausler <micahhausler@users.noreply.github.com>
Co-authored-by: Micah Hausler <micahhausler@users.noreply.github.com>
There was a problem hiding this 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!
[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:
Approvers can indicate their approval by writing |
./hack/changelog.py
to prepend the new changelog to the beginning of the existing changelog with the correct formatting.