From d0523b9eb38c4db5f036ffe24840ae0efb58ae71 Mon Sep 17 00:00:00 2001 From: "Christian M. Adams" Date: Wed, 2 Jun 2021 17:30:33 -0400 Subject: [PATCH] Update Release Process docs --- README.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 922c6aff..75d3d184 100644 --- a/README.md +++ b/README.md @@ -662,12 +662,9 @@ Please visit [our contributing guidelines](https://github.com/ansible/awx-operat There are a few moving parts to this project: - 1. The Docker image which powers AWX Operator. - 2. The `awx-operator.yaml` Kubernetes manifest file which initially deploys the Operator into a cluster. - 3. Then use the command below to generate a list of commits between the versions. - ```sh - #> git log --no-merges --pretty="- %s (%an) - %h " .. - ``` + * The `awx-operator` container image which powers AWX Operator + * The `awx-operator.yaml` file, which initially deploys the Operator + * The ClusterServiceVersion (CSV), which is generated as part of the bundle and needed for the olm-catalog Each of these must be appropriately built in preparation for a new tag: @@ -698,7 +695,7 @@ After it is built, test it on a local cluster: #> minikube delete ``` -### Update version +### Update version and files Update the awx-operator version: @@ -710,6 +707,23 @@ Once the version has been updated, run from the root of the repo: #> ansible-playbook ansible/chain-operator-files.yml ``` +Generate the olm-catalog bundle. + +```bash +$ operator-sdk generate bundle --operator-name awx-operator --version +``` + +> This should be done with operator-sdk v0.19.4. + +> It is a good idea to use the [build script](./build.sh) at this point to build the catalog and test out installing it in Operator Hub. + +### Update changelog + +Generate a list of commits between the versions and add it to the [changelog](./CHANGELOG.md). +```sh +#> git log --no-merges --pretty="- %s (%an) - %h " .. +``` + ### Commit / Create Release If everything works, commit the updated version, then [publish a new release](https://github.com/ansible/awx-operator/releases/new) using the same version you used in `ansible/group_vars/all`.