registry-operator release automation

Makefile

@@ -262,11 +262,14 @@ $(ENVTEST): $(LOCALBIN)
 	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) GOFLAGS="" go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
 
 # Generate bundle manifests and metadata, then validate generated files.
+## sh replace-alm-examples.sh is there to fix an issue with Kustomize removing List items
+## More information can be found here: https://github.com/kubernetes-sigs/kustomize/issues/5042
 .PHONY: bundle
 bundle: manifests
 	$(OPERATOR_SDK_CLI) generate kustomize manifests -q
 	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG)
 	$(KUSTOMIZE) build config/manifests | $(OPERATOR_SDK_CLI) generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
+	sh replace-alm-examples.sh
 	$(OPERATOR_SDK_CLI) bundle validate ./bundle
 
 # Build the bundle image.
@@ -285,3 +288,9 @@ gosec:
 	# Run this command to install gosec, if not installed:
 	# go install github.com/securego/gosec/v2/cmd/gosec@v2.14.0
 	gosec -no-fail -fmt=sarif -out=gosec.sarif -exclude-dir pkg/test -exclude-dir tests ./...
+
+### Release
+# RUN: make release NEW_VERSION=x.x.x
+.PHONY: 
+release:
+	sh make-release.sh ${NEW_VERSION}

README.md

@@ -97,6 +97,7 @@ The repository contains a Makefile; building and deploying can be configured via
 | `TARGET_OS` | Target operating system for operator manager build, **only for `make manager`** | `linux` |
 | `PLATFORMS` | Target architecture(s) for `make docker-buildx` | All supported: `linux/arm64,linux/amd64,linux/s390x,linux/ppc64le` |
 | `KUSTOMIZE_INSTALL_SCRIPT` | URL of kustomize installation script, see [kustomize installation instructions](https://kubectl.docs.kubernetes.io/installation/kustomize/binaries/) | `https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh` |
+| `NEW_VERSION` | Release version being cut | |
 
 Some of the rules supported by the makefile:
 
@@ -124,6 +125,7 @@ Some of the rules supported by the makefile:
 | fmt_license | Ensure license header is set on all files |
 | vet | Check suspicious constructs into code |
 | gosec | Check for security problems in non-test source files |
+| release | Starts the process for cutting a new release |
 
 To see all rules supported by the makefile, run `make help`
 

make-release.sh

@@ -0,0 +1,149 @@
+#!/bin/bash
+#
+#
+# Copyright Red Hat
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -eu
+
+usage ()
+{   echo "Usage: make release NEW_VERSION=<x.x.x>"
+    exit
+}
+
+if [[ $# -lt 1 ]]; then usage; fi
+
+SCHEMA_VERSION=$1
+FIRST_DIGIT="${SCHEMA_VERSION%%.*}"
+RELEASE_BRANCH="release-v${FIRST_DIGIT}"
+DEVFILE_REPO="git@github.com:devfile/registry-operator.git"
+RELEASE_UPSTREAM_NAME="devfile-upstream-release"
+
+if ! command -v hub > /dev/null; then
+  echo "[ERROR] The hub CLI needs to be installed. See https://github.com/github/hub/releases"
+  exit
+fi
+if [[ -z "${GITHUB_TOKEN}" ]]; then
+  echo "[ERROR] The GITHUB_TOKEN environment variable must be set."
+  exit
+fi
+if ! [[ "$SCHEMA_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+	echo >&2 "$SCHEMA_VERSION isn't a valid semver tag for the schema. Aborting..."
+	exit 1
+fi
+
+# Sets the upstream to devfile repo to ensure that git commands are performed on the correct repo
+# Ensures users who don't have an upstream set will be able to run script with no setup
+setUpstream(){
+  if git remote -v | grep -q "$RELEASE_UPSTREAM_NAME[[:space:]]\+$DEVFILE_REPO"; then
+    git remote rm ${RELEASE_UPSTREAM_NAME}
+  fi
+  git remote add ${RELEASE_UPSTREAM_NAME} "${DEVFILE_REPO}"
+}
+
+
+## Ensures local branch matches the remote
+resetChanges() {
+  echo "[INFO] Reset changes in $1 branch"
+  git reset --hard
+  git checkout $1
+  git fetch ${RELEASE_UPSTREAM_NAME} --prune
+  git pull ${RELEASE_UPSTREAM_NAME} $1
+}
+
+## Branch containing releases and tags in main upstream repo will be named 'release-vx' where 'vx' is the major release
+## All minor and patch releases will be contained within a major release branch
+## On the local side (the release engineers), the branches will be their full versioning name e.g. x.x.x
+## Local branch will create a PR to its respective major release branch (if exists) or create a new one
+checkoutToReleaseBranch() {
+  echo "[INFO] Checking out to $SCHEMA_VERSION branch."
+  if git ls-remote -q --heads | grep -q $SCHEMA_VERSION ; then
+    echo "[INFO] $SCHEMA_VERSION exists."
+    resetChanges $SCHEMA_VERSION
+  else
+    echo "[INFO] $SCHEMA_VERSION does not exist. Will create a new one from main."
+    resetChanges main
+    git push origin main:$SCHEMA_VERSION
+  fi
+  git checkout -B $SCHEMA_VERSION
+}
+
+
+updateVersionNumbers() {
+  SHORT_UNAME=$(uname -s)
+
+  ## Updating version.md based off of operating system
+  if [ "$(uname)" == "Darwin" ]; then
+    sed -i '' "s/^.*$/$SCHEMA_VERSION/" VERSION
+  elif [ "${SHORT_UNAME:0:5}" == "Linux" ]; then
+    sed -i "s/^.*$/$SCHEMA_VERSION/" VERSION
+  fi
+
+  ## Remaining version number updates to yaml files
+  yq eval ".metadata.annotations.containerImage = \"quay.io/devfile/registry-operator:v$SCHEMA_VERSION\"" --inplace ./config/manifests/bases/registry-operator.clusterserviceversion.yaml
+  yq eval ".metadata.name = \"registry-operator.v$SCHEMA_VERSION\"" --inplace ./config/manifests/bases/registry-operator.clusterserviceversion.yaml
+  yq eval ".spec.version = \"$SCHEMA_VERSION\"" --inplace ./config/manifests/bases/registry-operator.clusterserviceversion.yaml
+}
+
+# Export env variables that are used in bundle scripts
+exportEnvironmentVariables() {
+  CHANNEL=$(yq eval '.annotations."operators.operatorframework.io.bundle.channels.v1"' ./bundle/metadata/annotations.yaml)
+  export IMG=quay.io/devfile/registry-operator:v$SCHEMA_VERSION
+  export CHANNELS=$CHANNEL
+}
+
+# Commits version changes to your forked repository
+commitChanges() {
+  echo "[INFO] Pushing changes to $SCHEMA_VERSION branch"
+  git add -A
+  git commit -s -m "$1"
+  git push origin $SCHEMA_VERSION
+}
+
+# Creates a new branch in the registry-operator repo for a new major release
+# with the name release-vX
+## This func will be used when we have a new major release and there is no branch in the upstream repo
+createNewReleaseBranch(){
+  git checkout -b "${RELEASE_BRANCH}" main
+  git push "${RELEASE_UPSTREAM_NAME}" "${RELEASE_BRANCH}"
+}
+
+# Checks if release-vX branch is in the upstream
+# If it is not it creates the new major release branch based off main
+verifyReleaseBranch() {
+  if git ls-remote --exit-code --heads ${RELEASE_UPSTREAM_NAME} "$RELEASE_BRANCH" >/dev/null 2>&1; then
+      echo "Branch $RELEASE_BRANCH exists in the upstream repository."
+  else
+      echo "Branch $RELEASE_BRANCH does not exist in the upstream repository."
+      createNewReleaseBranch
+  fi
+}
+
+createPullRequest(){
+  echo "[INFO] Creating a PR"
+  hub pull-request --base devfile:${RELEASE_BRANCH} --head ${SCHEMA_VERSION} -m "$1"
+}
+
+main(){
+  setUpstream
+  checkoutToReleaseBranch
+  updateVersionNumbers
+  exportEnvironmentVariables
+  make bundle
+  commitChanges "chore(release): release version ${SCHEMA_VERSION}"
+  verifyReleaseBranch
+  createPullRequest "v${SCHEMA_VERSION} Release"
+}
+
+main

replace-alm-examples.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+#
+#
+# Copyright Red Hat
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+ALM_EXAMPLES=$(yq -r '.metadata.annotations.alm-examples' ./config/manifests/bases/registry-operator.clusterserviceversion.yaml)
+yq -i ".metadata.annotations.alm-examples = ($ALM_EXAMPLES | to_json)" ./bundle/manifests/registry-operator.clusterserviceversion.yaml