Skip to content

docs: document lightweight release process #38

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

Open
jbw976 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document lightweight release process #38

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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,20 @@ will be updated to match the Crossplane patch version. The `image` referenced by
the [distribution] plugin in any particular release branch is always the
authoritative conformance test for that major and minor version of Crossplane.

## Releases

To create a new release of this conformance suite for a new Crossplane version,
we follow a lightweight process:

* Create a release branch named `release-X.Y` using the Github UI
* On the release branch
* Open/merge a PR to pin the release version in `plugin-crossplane.yaml`: [example PR]
* Run the Tag workflow with `vX.Y.0-cf.1`
* Run the CI workflow
* On main branch
* Run the Tag workflow with `vX.Y+1.0-cf.1-rc.0`

[sonobuoy]: https://sonobuoy.io/
[crossplane]: https://crossplane.io/
[distribution]: ./plugin-crossplane.yaml
[example PR]: https://github.com/crossplane/conformance/pull/37