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.

Sign up for GitHub

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

📖 docs: Update release documentation and add backport policies #490

Closed
wants to merge 1 commit into from
Closed

📖 docs: Update release documentation and add backport policies #490

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 44 additions & 7 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Before starting, ensure the milestone is cleaned up. All issues that need to
get into the release should be closed and any issue that won't make the release
should be pushed to the next milestone.

These instructions use `v0.Y.0` as the example release. Please ensure to replace
These instructions use `v1.MINOR.PATCH` as the example release. Please ensure to replace
the version with the correct release being cut. It is also assumed that the upstream
operator-framework/catalogd repository is the `upstream` remote on your machine.

Expand All @@ -25,19 +25,56 @@ operator-framework/catalogd repository is the `upstream` remote on your machine:
git checkout main
git fetch upstream
git pull upstream main
git checkout -b release-v0.Y
git push upstream release-v0.Y
git checkout -b release-v1.Y
git push upstream release-v1.Y
```

2. Tag the release:

- ```sh
git tag -am "catalogd v0.Y.0" v0.Y.0
git push upstream v0.Y.0
git tag -am "catalogd v1.Y.0" v1.Y.0
git push upstream v1.Y.0
```

3. Check the status of the [release GitHub Action](https://github.com/operator-framework/catalogd/actions/workflows/release.yaml).
Once it is complete, the new release should appear on the [release page](https://github.com/operator-framework/catalogd/releases).

4. Clean up the GitHub milestone:
- In the [GitHub milestone](https://github.com/operator-framework/catalogd/milestones), bump any open issues to the following release and then close out the milestone.
### Procedure for Patch Releases

1. Create Pull requests against the release branch with cherry-picks of the commits that need to be included in the patch release.

- ```sh
git checkout -b release-v1.Y
git checkout -b my-cherry-pick-branch
git cherry-pick -x <commit-hash>
git push origin +my-cherry-pick-branch
```

2. Once all required PRs cherry-picks are merged and we are prepared to cut the patch release, create the PATCH release from the branch:

- ```sh
git checkout main
git fetch upstream
git checkout release-v1.Y
git tag -am "catalogd v1.Y.PATCH" v1.Y.PATCH
git push upstream v1.Y.PATCH
```

3. Check the status of the [release GitHub Action](https://github.com/operator-framework/catalogd/actions/workflows/release.yaml).
Once it is complete, the new release should appear on the [release page](https://github.com/operator-framework/catalogd/releases).

## Backporting Policy

Mainly critical issue fixes are backported to the most recent minor release.
Special backport requests can be discussed during the weekly Community meeting or via Slack channel;
this does not guarantee an exceptional backport will be created.

Occasionally non-critical issue fixes will be backported, either at an approver’s discretion or by request as noted above.
For information on contacting maintainers and attending meetings, check the community repository.

### Process

1. Create a PR with the fix cherry-picked against to the release branch.
2. Ask for a review from the maintainers.
3. Once approved, merge the PR and perform the Patch Release steps above.

Loading