From b5f2c1947054d5ff66170d9be5d876840a0dc657 Mon Sep 17 00:00:00 2001 From: Christian Adams Date: Wed, 13 Sep 2023 16:28:11 -0400 Subject: [PATCH] Add docs for publishing new operator versions to OperatorHub (#1557) --- docs/contributors-guide/release-process.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/contributors-guide/release-process.md b/docs/contributors-guide/release-process.md index 6b458cf5..42007d83 100644 --- a/docs/contributors-guide/release-process.md +++ b/docs/contributors-guide/release-process.md @@ -8,3 +8,18 @@ After the draft release is created, publish it and the [Promote AWX Operator ima - Publish image to Quay - Release Helm chart + +After the GHA is complete, the final step is to run the [publish-to-operator-hub.sh](./hack/publish-to-operator-hub.sh) script, which will create a PR in the following repos to add the new awx-operator bundle version to OperatorHub: +* https://github.com/k8s-operatorhub/community-operators (community operator index) +* https://github.com/redhat-openshift-ecosystem/community-operators-prod (operator index shipped with Openshift) + +The usage is documented in the script itself, but here is an example of how you would use the script to publish the 2.5.3 awx-opeator bundle to OperatorHub. +Note that you need to specify the version being released, as well as the previous version. This is because the bundle has a pointer to the previous version that is it being upgrade from. This is used by OLM to create a dependency graph. + +```bash +$ VERSION=2.5.3 PREV_VERSION=2.5.2 ./publish-operator.sh +``` + +> Note: There are some quirks with running this on OS X that still need to be fixed, but the script runs smoothly on linux. + +As soon as CI completes successfully, the PR's will be auto-merged. Please remember to monitor those PR's to make sure that CI passes, sometimes it needs a retry.