Skip to content

Releasing JIMM

Kian Parvin edited this page Oct 12, 2026 · 1 revision

When you want to create a new release of JIMM follow these steps.

Preparation

Decide the version number

Semantic versioning is used to version releases of JIMM e.g. v3.10.6.

Create a tag for the release

Draft a release from: https://github.com/canonical/jimm/releases. Click "Select a tag" and then click "Create new tag" entering the desired new version. Select "Target" and point to the desired branch. Use the generate release notes button.

Note: Using a v at the beginning of the tag will trigger the release GitHub Action.

Verify release

The release process runs a set of Juju-dashboard tests against JIMM before starting the release process. If this fails the tests should be fixed. Make a PR and add the label "test-dashboard" to run the dashboard tests.

Optionally, to force a release use the workflow at https://github.com/canonical/jimm/actions/workflows/release-server-rock.yaml to release a new version of JIMM's OCI image.

Once the release process has completed the following artifacts should be created:

Update the JIMM charm

Make a pull-request to the https://github.com/canonical/jimm-k8s-operator repository to update JIMM's OCI image version see e.g. https://github.com/canonical/jimm-k8s-operator/pull/190/changes.

Landing a PR to the JIMM charm will release a new version of the charm and OCI image to Charmhub on the 3/edge channel. To promote the charm to other channel use the following actions https://github.com/canonical/jimm-k8s-operator/actions/workflows/promote.yaml. Note that there is no fixed schedule for promoting the charm.

After the release is complete, the new revision is available at https://github.com/canonical/jimm-k8s-operator/releases and on Charmhub.

Update production (optional)

To update IS's production instance of JIMM, file a Concordia ticket https://concordia.canonical.com/ requesting IS to upgrade to the new revision.

Done!

You have successfully released JIMM.