Skip to content

Commit 2b872b0

Browse files
authored
Merge pull request #392 from Fedosin/docs_release
📖 Update release docs
2 parents 2613401 + cf65987 commit 2b872b0

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

docs/release.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Releasing new versions
1+
# Releasing New Versions
22

3-
This documents describes release process for the Cluster API Operator.
3+
This document describes the release process for the Cluster API Operator.
44

5-
1. Create the release branch and cut release tag.
5+
1. Create a new release branch and cut a release tag.
66

77
```bash
88
git checkout -b release-0.1
@@ -24,35 +24,34 @@ git push upstream ${RELEASE_TAG}
2424
git push upstream test/${RELEASE_TAG}
2525
```
2626

27-
This will trigger [release github action](https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/.github/workflows/release.yaml) that will
28-
create a draft release with operator components and helm chart, also a Prow job to publish operator image to the staging registry will start.
27+
**Note:** You may encounter an ioctl error during tagging. To resolve this, you need to set the GPG_TTY environment variable as `export GPG_TTY=$(tty)`.
2928

30-
2. Wait for image to appear in the [staging registry](https://console.cloud.google.com/gcr/images/k8s-staging-capi-operator/global/cluster-api-operator).
29+
This will trigger a [release GitHub action](https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/.github/workflows/release.yaml) that creates a release with operator components and the Helm chart. Concurrently, a Prow job will start to publish operator images to the staging registry.
3130

32-
3. Create a GitHub [Personal access tokens](https://github.com/settings/tokens) if you don't have one already. We're going to use for opening a PR
33-
to promote image from staging to production.
31+
2. Wait for the images to appear in the [staging registry](https://console.cloud.google.com/gcr/images/k8s-staging-capi-operator/global/cluster-api-operator).
32+
33+
3. Create a GitHub [Personal access token](https://github.com/settings/tokens) if you don't already have one. We're going to use this for opening a PR to promote the images from staging to production.
3434

3535
```bash
3636
export GITHUB_TOKEN=<your GH token>
37+
export USER_FORK=<your GH account name>
3738
make promote-images
3839
```
3940

40-
Merge the PR after it was created and verify that image is present in the production registry.
41+
After it has been tested, merge the PR and verify that the image is present in the production registry.
4142

4243
```bash
4344
docker pull registry.k8s.io/capi-operator/cluster-api-operator:${RELEASE_TAG}
4445
```
4546

46-
4. Publish the release on Github.
47-
48-
5. After release was published, switch back to main branch and update index.yaml and clusterctl-operator.yaml. It's the source for operator helm chart repository and local krew plugin manifest index.
47+
4. Switch back to the main branch and update `index.yaml` and `clusterctl-operator.yaml`. These are the sources for the operator Helm chart repository and the local krew plugin manifest index, respectively.
4948

5049
```bash
5150
git checkout main
5251
make update-helm-plugin-repo
5352
```
5453

55-
6. Create a PR with the changes.
54+
5. Create a PR with the changes.
5655

5756
## Setup jobs and dashboards for a new release branch
5857

0 commit comments

Comments
 (0)