# cilium-cli Release Process

Release process and checklist for `cilium-cli`.

All releases in this repository are cut from the `main` branch. Refer to the
[Release table](https://github.com/cilium/cilium-cli#releases) for the most
recent supported versions.

## Check issues and PRs

- Merge all PRs marked as ready to merge [in the cilium-cli
  repository](https://github.com/cilium/cilium-cli/labels/ready-to-merge)
  and [in the cilium repository](https://github.com/cilium/cilium/pulls?q=state%3Aopen%20label%3Aready-to-merge%20label%3Acilium-cli)
- Make sure there are no [open issues or PRs labeled as release
  blocker](https://github.com/cilium/cilium-cli/labels/priority%2Frelease-blocker)
  in the cilium-cli repository
- Make sure there are no [release blockers](https://github.com/cilium/cilium/labels/release-blocker%2Fcilium-cli)
  in the cilium repository
- Make sure there are no [Dependabot alerts](https://github.com/cilium/cilium-cli/security/dependabot)
- Make sure the optional CI workflows for Cloud environments (eg. GKE, AKS) pass for the
  `main` branch in the cilium repository.

## Prepare environment variables

Set `RELEASE` environment variable to the new version. This variable will be
used in the commands throughout the documenat to allow copy-pasting.

    export RELEASE=v0.19.5

## Create release preparation branch and PR

Update your local checkout to the latest state:

    git checkout main
    git pull origin main

Create the release branch:

    git checkout -b pr/prepare-$RELEASE

Update `github.com/cilium/cilium` to the latest version:

    go get github.com/cilium/cilium@main
    go mod tidy && go mod vendor
    git add go.mod go.sum vendor

Update the *Releases* section of the `README.md` which lists all currently
supported releases in a table. The version in this table needs to be updated to
match the new release `$RELEASE`. Also bump `$RELEASE` in the section above, so
it can be copy-pasted when preparing the next release.

    git add README.md RELEASE.md
    git commit -s -m "Prepare for $RELEASE release"

Push the branch to the upstream repository:

    git push origin pr/prepare-$RELEASE

Then open a pull request against `main` branch. Wait for the PR to be reviewed
and merged.

## Tag a release

Update your local checkout:

    git checkout main
    git pull origin main

Set the commit you want to tag:

    export COMMIT_SHA=<commit-sha-to-release>

Usually this is the most recent commit on `main`, i.e.

    export COMMIT_SHA=$(git rev-parse origin/main)

Then tag and push the release:

    git tag -a $RELEASE -m "$RELEASE release" $COMMIT_SHA && git push origin $RELEASE

Review and approve the [release image build workflow
run](https://github.com/cilium/cilium-cli/actions/workflows/images-release.yaml)
to push the release image to https://quay.io/repository/cilium/cilium-cli?tab=tags&tag=latest.

## Update the GitHub release notes

When a tag is pushed, a GitHub Action job takes care of creating a new GitHub
draft release, building artifacts and attaching them to the draft release. Once
the draft is ready, review the release notes and publish the release.

### Update stable.txt

The CLI installation instructions in the Cilium documentation use the version
specified in `stable.txt` in the `main` branch. Update `stable.txt` after the
release, whenever Cilium users should pick up this new release for
installation:

    echo $RELEASE > stable.txt
    git checkout -b pr/update-stable-$RELEASE
    git add stable.txt
    git commit -s -m "Update stable release to $RELEASE"
    git push origin HEAD

Then open a pull request against `main` branch.
