From 8fd0ded12846d465606e4b2622301b78c4280363 Mon Sep 17 00:00:00 2001 From: Jared Watts Date: Fri, 19 Sep 2025 16:12:44 -0700 Subject: [PATCH] docs: document lightweight release process Signed-off-by: Jared Watts --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 1935258..8f90ea8 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file