Skip to main content
Version: Next 🚧

Releasing Install Operator

Release Process​

1. Preparing for Release​

a. Nothing in the repository needs a version bump. The image tag comes from the git tag via github.ref_name.

b. Run make manifests generate locally and commit any diff. CI runs both as part of make test, but it regenerates in place and then tests the regenerated tree, so it will never fail on stale CRDs or zz_generated files.

c. This is a Kubebuilder v4 project. The API is InstallEpinio v1alpha1 in group epinio, domain apps.epinio.io, so a change to api/v1alpha1 means regenerated CRDs under config/crd/bases.

2. Reviewing the PR​

a. Three checks run on every PR: Lint (lint.yml), Tests (test.yml), and E2E Tests (test-e2e.yml). Each one is also exposed as a reusable workflow via workflow_call.

b. All three name their job Run on Ubuntu, so the PR shows three checks with the same name. You have to open each one to tell lint from unit tests from e2e.

c. E2E creates a real kind cluster called epinio-test-e2e, runs the ginkgo suite in test/e2e/, then deletes the cluster.

3. Cutting the Release​

a. Push a tag of the form v<version>. Only a tag push triggers Publish (publish.yml); there is no manual dispatch.

b. Publish re-runs lint, test, and test-e2e as reusable workflows, then runs build-push with needs: [lint, test, test-e2e], so a failure in any of the three blocks the image.

c. build-push logs into ghcr.io using the GHCR_PUSH secret, sets up Buildx, and runs make docker-buildx IMG=ghcr.io/epinio/install-operator:<tag> across four platforms: linux/amd64, arm64, s390x, and ppc64le.

4. Post Release Tasking​

a. Confirm the image actually exists at ghcr.io/epinio/install-operator:<tag>. The docker-buildx target in the Makefile prefixes its buildx build --push line with a dash, so make ignores a failed push and the workflow still reports success. A green Publish run is not proof that anything was pushed.

b. No :latest tag is pushed, so anything tracking latest needs the explicit version.

c. The Helm chart in charts/install-operator is not published by any workflow. If consumers need it, package and publish it by hand, or install it from the repo.

d. Its important to close out or update any public GitHub issues that were resolved as part of the release, and clean up branches.