Merge pull request #28 from embik/automate-provider-releases

🌱 Define release process and provide script to create release commit

Author: k8s-ci-robot

Makefile

@@ -177,6 +177,15 @@ APIDIFF_OLD_COMMIT ?= $(shell git rev-parse origin/main)
 verify-apidiff: $(GO_APIDIFF) ## Check for API differences
 	$(GO_APIDIFF) $(APIDIFF_OLD_COMMIT) --print-compatible
 
+## --------------------------------------
+## Release Tooling
+## --------------------------------------
+
+
+.PHONY: provider-release
+provider-release: ## Create a commit bumping the provider modules to the latest release tag and tag providers.
+	@./hack/release-providers.sh
+
 ## --------------------------------------
 ## Helpers
 ## --------------------------------------

docs/development/release-process.md

@@ -0,0 +1,24 @@
+# Release Process
+
+This repository includes serveral Go modules: The "main" Go module `sigs.k8s.io/multicluster-runtime` and several provider modules.
+
+The release process is partially automated. The following steps need to be taken:
+
+1. Create a new branch, e.g. `prepare-0.24.0-alpha.7` from `main` (or the respective release branch).
+2. Run `./hack/release-commit.sh <version>` (e.g. `./hack/release-commit.sh v0.24.0-alpha.7`).
+3. Push the resulting branch and open a PR to get it merged into `main` (or the respective release branch).
+4. Once merged, follow the instructions in the output of `./hack/release-commit.sh` and push the release tags.
+
+This release process makes sure that _all_ tags for a release are on the same commit (the commit generated by the script).
+
+## `release-commit.sh`
+
+Behaviour of this script can be adjusted with the following environment variables:
+
+- `GIT_TAG_OPTIONS`: Optional flags to be passed to `git tag`. Example: `GIT_TAG_OPTIONS=-s` to sign git tags with your GPG key.
+- `GIT_COMMIT_OPTIONS`: Optional flags to be passed to `git commit`. Example: `GIT_COMMIT_OPTIONS=-s -S` to sign-off on your commits and sign them with your GPG key.
+- `GIT_COMMIT_PUSH` and `GIT_COMMIT_REMOTE`: To push the release commit automatically. Need to be both set. Example: `GIT_COMMIT_PUSH=1 GIT_COMMIT_REMOTE=fork`.
+
+## Versioning
+
+`sigs.k8s.io/multicluster-runtime` follows the `sigs.k8s.io/controller-runtime` version for ease of use (e.g. the version of multicluster-runtime that depends on controller-runtime `v0.20.4` must also be `v0.20.4`). Make sure that [go.mod](../../go.mod) contains the right dependency before tagging a new release.

hack/release-commit.sh

@@ -0,0 +1,65 @@
+#! /usr/bin/env bash
+# Copyright 2025 The Kubernetes Authors.
+#
+# 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 -o errexit
+
+TAG=${1}
+GIT_TAG_OPTIONS=${GIT_TAG_OPTIONS:-}
+GIT_COMMIT_OPTIONS=${GIT_COMMIT_OPTIONS:-}
+GIT_COMMIT_PUSH=${GIT_COMMITS_PUSH:-}
+GIT_COMMIT_REMOTE=${GIT_COMMITS_REMOTE:-}
+
+echo "Updating all modules ..."
+
+find "providers" "examples" -name go.mod | while read -r GOMOD; do
+    module=$(dirname "${GOMOD}")
+    if [ "$(git tag -l "${module}/${TAG}")" ]; then
+        echo "${module}/${LTAG} already exists. Do you really need to run this script?"
+        exit 1
+    fi
+
+    pushd "${module}"
+    go get "sigs.k8s.io/multicluster-runtime@${TAG}"
+    go mod tidy
+    popd
+done
+
+echo "Creating release commit ..."
+
+git add ./providers/ ./examples/
+git commit -m "Prepare release for sigs.k8s.io/multicluster-runtime@${TAG}" ${GIT_COMMIT_OPTIONS}
+
+if [ -n "$GIT_COMMIT_PUSH" ] && [ -n "$GIT_COMMIT_REMOTE" ]; then
+    echo "Pushing release commit to ${GIT_COMMIT_REMOTE} ..."
+    git push "${GIT_COMMIT_REMOTE}"
+fi
+
+echo "Creating release tags ..."
+
+# set up main tag
+git tag -am "${TAG}" "${TAG}" ${GIT_TAG_OPTIONS}
+echo "Created tag ${TAG}."
+
+# create provider and example tags
+find "providers" "examples" -name go.mod | while read -r GOMOD; do
+    module=$(dirname "${GOMOD}")
+    git tag -am "${module}/${TAG}" "${module}/${TAG}" ${GIT_TAG_OPTIONS}
+    echo "Created tag ${module}/${TAG}."
+done
+
+echo ""
+echo "Tags have been successfully created on the release commit."
+echo "As a next step, open a PR for your branch in kubernetes-sigs/multicluster-runtime."
+echo "Once the PR has been merged, push all git tags created above.