RELEASE.md

How to release Limitador Operator

Process

To release a version “v0.W.Z” of Limitador Operator in GitHub and Quay.io, follow these steps:

1. Pick a stable (released) version “v0.X.Y” of the operand known to be compatible with operator’s image for “v0.W.Z”; if needed, make a release of the operand first.

2. Run the GHA Release operator; make sure to fill all the fields:

   • Branch containing the release workflow file – default: main
   • Commit SHA or branch name of the operator to release – usually: main
   • Operator version to release (without prefix) – i.e. 0.W.Z
   • Limitador version the operator enables installations of (without prefix) – i.e. 0.X.Y
   • Operator replaced version (without prefix) – i.e. 0.P.Q
   • If the release is a prerelease

3. Run the GHA Build and push images for the “v0.W.Z” tag, specifying ‘Limitador version’ equals to “0.X.Y”. This will cause the new images (bundle and catalog included) to be built and pushed to the corresponding repos in quay.io/kuadrant.

Publishing the Operator in OpenShift Community Operators

Open a PR in the OpenShift Community Operators repo (example | docs).

The usual steps are:

1. Start a new branch named limitador-operator-v0.W.Z

2. Create a new directory operators/limitador-operator/0.W.Z containing:

   • Copy the bundle files from github.com/kuadrant/limitador-operator/tree/v0.W.Z/bundle
   • Copy github.com/kuadrant/limitador-operator/tree/v0.W.Z/bundle.Dockerfile with the proper fix to the COPY commands (i.e. remove /bundle from the paths)

Publishing the Operator in Kubernetes Community Operators (OperatorHub.io)

1. Open a PR in the Kubernetes Community Operators repo (example | docs).

2. The usual steps are the same as for the OpenShift Community Operators hub.