-
Notifications
You must be signed in to change notification settings - Fork 17
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
Initial Release Instructions #223
Merged
openshift-merge-bot
merged 1 commit into
shipwright-io:main
from
adambkaplan:operator-release
Jun 27, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# Release Process | ||
|
||
This document outlines the steps required to release the operator. This document assumes that you | ||
have achieved the "Approver"/"Maintainer" status, and have permission to manually trigger GitHub | ||
Actions on this repo. | ||
|
||
## Release Candidates (`X.Y.0-rcN`) | ||
|
||
### Step 0: Set Up the Release Branch | ||
|
||
Run the "Create Release Branch" GitHub Action, providing a valid Semantic Version with a major and | ||
minor revision number. Example: `v0.13`. | ||
|
||
### Step 1: Create a Release Candidate | ||
|
||
This is ideal for `.0` releases, where there is most risk of "blocking" bugs. Release candidates | ||
can be skipped for z-stream releases. | ||
|
||
Run the "Release" GitHub action, with the following parameters: | ||
|
||
- New tag: provide a semantic version _without the leading `v`_. Use a trailing `-` to add patch | ||
suffix. Ex: 0.13.0-rc0. | ||
- Previous tag: provide a semantic version _that matches a tag on the GitHub repo_. Ex: `v0.12.0`. | ||
- Ref: use the branch for the release in question. Ex: `release-v0.13`. | ||
|
||
This will draft a release for GitHub - it will not publish a tag or release note. | ||
|
||
### Step 2: Publish Draft Release | ||
|
||
Find the draft release. Edit the release as follows: | ||
|
||
- Add a leading `v` suffix to the generated tag and release name. Ex: `0.13.0-rc0` becomes `v0.13.0-rc0`. | ||
- Change the "Draft release notes" title to "What's Changed". | ||
|
||
Once you're happy, publish the draft release note. If an item is missing from the release note, | ||
review the pull requests that should be included. Each desired PR should have: | ||
|
||
1. A release note. | ||
2. A `kind/*` label, such as `kind/feature` or `kind/bug`. | ||
|
||
### Step 3: Verify the Bundle | ||
|
||
Once the release candidate is published, broadcast the candidate build to the community in Slack | ||
and the shipwright-dev mailing list. Refer to the "Testing a Release" section of the | ||
[OLM Development](./olm-development.md#testing-a-release) guide for instructions on how to test the | ||
release candidate. | ||
|
||
### Step 4: Triage/Fix bugs | ||
|
||
Once the release candidate is published, the community should file any issues as bugs in GitHub. It | ||
is up to maintainers to determine which bugs are "release blockers" and which ones can be addressed | ||
in a future release. | ||
|
||
### Step 5: Repeat Release Candidates | ||
|
||
Repeat steps 1-4 as needed if a "release blocker" issue is identified. | ||
|
||
## Official Releases | ||
|
||
Before proceeding with an official release, ensure that the | ||
[release branch](#step-0-set-up-the-release-branch) has been set up. | ||
|
||
### Step 1: Bump versions for release | ||
|
||
Once bugs have been triaged and the community feels ready, submit pull requests to bump the | ||
`VERSION` make variable. For a new release, there should be two pull requests: | ||
|
||
1. One for the `main` branch to update the minor semantic version. Ex: Update `0.12.0-rc0` to | ||
`0.13.0-rc0` | ||
2. One for the `release-v*` branch, dropping any release candidate patch suffixes and/or updating | ||
the patch semantic version itself. Ex: `0.13.0` to `0.13.1`. | ||
|
||
In both cases, run `make bundle` and commit any generated changes as part of the pull request. | ||
Work with the community to get these pull requests merged. | ||
|
||
### Step 2: Publish the Release | ||
|
||
Repeat the process in [Step 1](#step-1-create-a-release-candidate) and | ||
[Step 2](#step-2-publish-draft-release) above to create the release. For an official release, the | ||
version should adhere to the `X.Y.Z` format (not extra dashes). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Could we avoid the need for this manual step?
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.
Yes - I'll create an issue for follow-up.