From 123141f88a0e7cd5d709cac45886949a1429a64b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Fri, 1 Sep 2023 19:53:48 +0200
Subject: [PATCH 01/12] release-process: sed command not compatible with BSD
sed
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 20 ++++++++++++++------
1 file changed, 14 insertions(+), 6 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index 30d273485a9..b1d86e75aa6 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -198,11 +198,19 @@ page if a step is missing or if it is outdated.
The steps below need to happen using `master` (**final release**) or
`release-1.x` (**patch release**). The PR will be merged after the release.
- 1. Go to the Generate `release-notes.md` using the instructions further below
- (Ctrl+F and look for `github-release-description.md`).
+ Go to the section "Generate `github-release-description.md`" using the
+ instructions further below (Ctrl+F and look for
+ `github-release-description.md`).
2. Remove the "Dependencies" section.
- 3. Edit any `release-note` block in the PR description that doesn't follow
- the [release-note guidelines](../contributing/contributing-flow.md#release-note-guidelines)
+ 3. For each bullet point in the Markdown file, read the changelog entry and
+ check that it follows the [release-note
+ guidelines](../contributing/contributing-flow.md#release-note-guidelines).
+ If you find a changelog entry that doesn't follow the guidelines, then:
+ - Go to that PR and edit the PR description to change the contents of the
+ `release-note` block.
+ - Go back to the release notes page, and copy the same change into
+ `release-notes.md` (or re-generate the file).
+
and copy the same change into `release-notes.md` (or re-generate the
file).
4. Add the section "Major themes" and "Community" by taking example on the
@@ -211,11 +219,11 @@ page if a step is missing or if it is outdated.
`@maelvls`) with actual links using the following command:
```bash
- sed github-release-description.md \
+ sed \
-e 's$#([0-9]+)$[#\1](https://github.com/cert-manager/cert-manager/pull/\1)$g' \
-e 's$@(\w+)$[@\1](https://github.com/\1)$g' \
-E \
- -i
+ github-release-description.md >release-notes.md
```
6. Move `release-notes.md` to the website repo:
From f6d5d41e38486ba8c52fd7f9fae5a2686824b748 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Fri, 1 Sep 2023 17:23:58 +0200
Subject: [PATCH 02/12] release-process: fix find command being too loose
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index b1d86e75aa6..34578b01f4b 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -269,11 +269,11 @@ page if a step is missing or if it is outdated.
+genversionwithcli "release-1.12" "$LATEST_VERSION"
```
- 4. (**final + patch release**) Bump all versions present in installation
+ 4. (**final + patch release of the latest minor version**) Bump all versions present in installation
instructions. To find these versions:
```bash
- find ./content/docs/installation -name '*.md' -not -path '*/upgrad**' -exec sed -i.bak 's/1.11../1.12.0/g' '{}' \;
+ find ./content/docs/installation -name '*.md' -not -path '*/upgrad**' -and -not -path '*supported-releases.md' -exec sed -i.bak 's/1.11./1.12.0/g' '{}' \;
rm -f **/*.bak
```
From 7eb34ca81ca5c9abc596b78c5168b1c5e4edaaf6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Fri, 1 Sep 2023 17:47:30 +0200
Subject: [PATCH 03/12] release-process: jetstack -> cert-manager
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index 34578b01f4b..ad9f3dc8d1c 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -269,8 +269,8 @@ page if a step is missing or if it is outdated.
+genversionwithcli "release-1.12" "$LATEST_VERSION"
```
- 4. (**final + patch release of the latest minor version**) Bump all versions present in installation
- instructions. To find these versions:
+ 4. (**final + patch release of the latest minor version**) Bump all versions
+ present in installation instructions. To find these versions:
```bash
find ./content/docs/installation -name '*.md' -not -path '*/upgrad**' -and -not -path '*supported-releases.md' -exec sed -i.bak 's/1.11./1.12.0/g' '{}' \;
@@ -316,8 +316,8 @@ page if a step is missing or if it is outdated.
It should show:
```text
- origin https://github.com/jetstack/cert-manager (fetch)
- origin https://github.com/jetstack/cert-manager (push)
+ origin https://github.com/cert-manager/cert-manager (fetch)
+ origin https://github.com/cert-manager/cert-manager (push)
```
7. Place yourself on the correct branch:
From 876e03792b750010b174624e3cfb7c60bb9883ed Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Fri, 1 Sep 2023 18:01:57 +0200
Subject: [PATCH 04/12] release-process: the update-cmd/ctl/ thing only works
for 1.12 and above
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index ad9f3dc8d1c..1874e993315 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -399,8 +399,8 @@ page if a step is missing or if it is outdated.
> kicking off a build using the steps in `gcb/build_cert_manager.yaml`. Users with access to
> the cert-manager-release project on GCP should be able to view logs in [GCB build history](https://console.cloud.google.com/cloud-build/builds?project=cert-manager-release).
-9. In this step, we make sure the Go module
- `github.com/cert-manager/cert-manager/cmd/cmctl` can be imported by
+9. **(1.12 and above)** In this step, we make sure the Go module
+ `github.com/cert-manager/cert-manager/cmd/ctl` can be imported by
third-parties.
First, create a temporary branch.
@@ -410,20 +410,20 @@ page if a step is missing or if it is outdated.
git checkout -b "update-cmd/ctl/$RELEASE_VERSION"
```
- Second, update the `cmd/cmctl`'s `go.mod` with the tag we just created:
+ Second, update the `cmd/ctl`'s `go.mod` with the tag we just created:
```bash
# Must be run from the cert-manager repo folder.
- cd cmd/cmctl
+ cd cmd/ctl
go get github.com/cert-manager/cert-manager@$RELEASE_VERSION
cd ../..
find . -name go.mod -not -path ./_bin/\* -exec dirname '{}' \; | xargs -L1 -I@ sh -c 'cd @; go mod tidy'
git add **/go.mod **/go.sum
- git commit -m"Update cmd/cmctl's go.mod to $RELEASE_VERSION"
+ git commit -m"Update cmd/ctl's go.mod to $RELEASE_VERSION"
```
- Third, create a tag for the `cmd/cmctl` module:
+ Third, create a tag for the `cmd/ctl` module:
```bash
# Must be run from the cert-manager repo folder.
From 17763b11476675aab1fcae3cef0a6ed455c0f5b0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Fri, 1 Sep 2023 18:19:05 +0200
Subject: [PATCH 05/12] release-process: reformulate 1.10-specific parts
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 60 +++++++++-----------
1 file changed, 28 insertions(+), 32 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index 1874e993315..aaabcd95f06 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -495,46 +495,42 @@ page if a step is missing or if it is outdated.
4. **(final release only)** Write the "Community" section, following the example of past releases such as [v1.12.0](https://github.com/cert-manager/cert-manager/releases/tag/v1.12.0). If there are any users who didn't make code contributions but helped in other ways (testing, PR discussion, etc), be sure to thank them here!
-11. Check that the build is complete and send Slack messages about the release:
+11. Check that the build that was automatically triggered when you pushed the
+ tag is complete and send Slack messages about the release:
- 1. For recent versions of cert-manager, the build will have been automatically
- triggered by the tag being pushed earlier. You can check if it's complete on
- the [GCB Build History](https://console.cloud.google.com/cloud-build/builds?project=cert-manager-release).
-
- 2. If you're releasing an older version of cert-manager (earlier than 1.10) then the automatic build
- will failed because the GCB config for that build wasn't backported.
- In this case, you'll need to trigger the build manually using `cmrel`, which takes about 5 minutes:
-
- ```bash
- # Must be run from the "cert-manager/release" repo folder.
- cmrel makestage --ref=$RELEASE_VERSION
- ```
-
- This build takes ~5 minutes. It will build all container images and create
- all the manifest files, sign Helm charts and upload everything to a storage
- bucket on Google Cloud. These artifacts will then be published and released
- in the next steps.
-
- 3. In any case, send a first Slack message to `#cert-manager-dev`:
+ 1. Send a first Slack message to `#cert-manager-dev`:
Releasing 1.2.0-alpha.2
🧵
-
- 🔰 Please have a quick look at the build log as it might contain some unredacted
- data that we forgot to hide. We try to make sure the sensitive data is
- properly redacted but sometimes we forget to update this.
-
+ 2. Check that the build completed in the [GCB Build
+ History](https://console.cloud.google.com/cloud-build/builds?project=cert-manager-release).
+
+
+ 🔰 Please have a quick look at the build log as it might contain some unredacted
+ data that we forgot to hide. We try to make sure the sensitive data is
+ properly redacted but sometimes we forget to update this.
+
+
+ > **NOTE (1.10 and earlier):** If you're releasing an older version of
+ > cert-manager then the automatic build will failed because the GCB config
+ > for that build wasn't backported. In this case, you'll need to trigger the
+ > build manually using `cmrel`, which takes about 5 minutes:
+ >
+ > ```bash
+ > # Must be run from the "cert-manager/release" repo folder.
+ > cmrel makestage --ref=$RELEASE_VERSION
+ > ```
- 4. Send a second Slack message in reply to this first message with the
- Cloud Build job link. For example, the message might look like:
+ 3. Copy the build logs URL and send a second Slack message in reply to this first message with the Cloud
+ Build job link. For example, the message might look like:
- Follow the cmrel makestage
build: https://console.cloud.google.com/cloud-build/builds/7641734d-fc3c-42e7-9e4c-85bfc4d1d547?project=1021342095237
+ cmrel makestage
build logs: https://console.cloud.google.com/cloud-build/builds/7641734d-fc3c-42e7-9e4c-85bfc4d1d547?project=1021342095237
-12. Run `cmrel publish`:
+13. Run `cmrel publish`:
1. Do a `cmrel publish` dry-run to ensure that all the staged resources are
valid. Run the following command:
@@ -579,7 +575,7 @@ page if a step is missing or if it is outdated.
Follow the cmrel publish
build: https://console.cloud.google.com/cloud-build/builds/b6fef12b-2e81-4486-9f1f-d00592351789?project=1021342095237
-13. Publish the GitHub release:
+14. Publish the GitHub release:
1. Visit the draft GitHub release and paste in the release notes that you
generated earlier. You will need to manually edit the content to match
@@ -594,7 +590,7 @@ page if a step is missing or if it is outdated.
4. Click "Publish" to make the GitHub release live.
-14. Merge the pull request containing the Helm chart:
+15. Merge the pull request containing the Helm chart:
The Helm charts for cert-manager are served using Cloudflare pages
and the Helm chart files and metadata are stored in the [Jetstack charts repository](https://github.com/jetstack/jetstack-charts).
@@ -606,7 +602,7 @@ page if a step is missing or if it is outdated.
4. Merge the PR
5. Check that the [cert-manager Helm chart is visible on ArtifactHUB](https://artifacthub.io/packages/helm/cert-manager/cert-manager).
-15. **(final + patch releases)** Merge the 4 Website PRs:
+16. **(final + patch releases)** Merge the 4 Website PRs:
1. Merge the PRs "Release Notes", "Upgrade Notes", and "Freeze And Bump
Versions" that you have created previously.
From fa52c9e57e6f41668ce35c3689cfe482e686cea4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Fri, 1 Sep 2023 18:40:24 +0200
Subject: [PATCH 06/12] release-process: fix release-notes already-ready URLs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 59 +++++++++++---------
1 file changed, 33 insertions(+), 26 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index aaabcd95f06..0b0d02f15e8 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -476,16 +476,22 @@ page if a step is missing or if it is outdated.
2. Generate `github-release-description.md` with the following command:
- ```bash
- # Must be run from the cert-manager folder.
- export GITHUB_TOKEN=*your-token*
- git fetch origin $BRANCH
- export START_SHA="$(git rev-list --reverse --ancestry-path $(git merge-base $START_TAG $BRANCH)..$BRANCH | head -1)"
- release-notes --debug --repo-path cert-manager \
- --org cert-manager --repo cert-manager \
- --required-author "jetstack-bot" \
- --output github-release-description.md
- ```
+ ```bash
+ # Must be run from the cert-manager folder.
+ export GITHUB_TOKEN=*your-token*
+ git fetch origin $BRANCH
+ export START_SHA="$(git rev-list --reverse --ancestry-path $(git merge-base $START_TAG $BRANCH)..$BRANCH | head -1)"
+ release-notes --debug --repo-path cert-manager \
+ --org cert-manager --repo cert-manager \
+ --required-author "jetstack-bot" \
+ --markdown-links=false \
+ --output github-release-description.md
+ ```
+
+
+ The GitHub token **does not need any scope**. The token is required
+ only to avoid rate-limits imposed on anonymous API users.
+
The GitHub token **does not need any scope**. The token is required
@@ -504,33 +510,34 @@ page if a step is missing or if it is outdated.
Releasing 1.2.0-alpha.2
🧵
- 2. Check that the build completed in the [GCB Build
- History](https://console.cloud.google.com/cloud-build/builds?project=cert-manager-release).
+ 2. Check that the build completed in the
+ [GCB Build History](https://console.cloud.google.com/cloud-build/builds?project=cert-manager-release).
-
- 🔰 Please have a quick look at the build log as it might contain some unredacted
- data that we forgot to hide. We try to make sure the sensitive data is
- properly redacted but sometimes we forget to update this.
-
+
+ 🔰 Please have a quick look at the build log as it might contain some unredacted
+ data that we forgot to hide. We try to make sure the sensitive data is
+ properly redacted but sometimes we forget to update this.
+
> **NOTE (1.10 and earlier):** If you're releasing an older version of
- > cert-manager then the automatic build will failed because the GCB config
- > for that build wasn't backported. In this case, you'll need to trigger the
- > build manually using `cmrel`, which takes about 5 minutes:
+ > cert-manager then the automatic build will failed because the GCB
+ > config for that build wasn't backported. In this case, you'll need to
+ > trigger the build manually using `cmrel`, which takes about 5 minutes:
>
> ```bash
> # Must be run from the "cert-manager/release" repo folder.
> cmrel makestage --ref=$RELEASE_VERSION
> ```
- 3. Copy the build logs URL and send a second Slack message in reply to this first message with the Cloud
- Build job link. For example, the message might look like:
+ 3. Copy the build logs URL and send a second Slack message in reply to this
+ first message with the Cloud Build job link. For example, the message
+ might look like:
cmrel makestage
build logs: https://console.cloud.google.com/cloud-build/builds/7641734d-fc3c-42e7-9e4c-85bfc4d1d547?project=1021342095237
-13. Run `cmrel publish`:
+12. Run `cmrel publish`:
1. Do a `cmrel publish` dry-run to ensure that all the staged resources are
valid. Run the following command:
@@ -575,7 +582,7 @@ page if a step is missing or if it is outdated.
Follow the cmrel publish
build: https://console.cloud.google.com/cloud-build/builds/b6fef12b-2e81-4486-9f1f-d00592351789?project=1021342095237
-14. Publish the GitHub release:
+13. Publish the GitHub release:
1. Visit the draft GitHub release and paste in the release notes that you
generated earlier. You will need to manually edit the content to match
@@ -590,7 +597,7 @@ page if a step is missing or if it is outdated.
4. Click "Publish" to make the GitHub release live.
-15. Merge the pull request containing the Helm chart:
+14. Merge the pull request containing the Helm chart:
The Helm charts for cert-manager are served using Cloudflare pages
and the Helm chart files and metadata are stored in the [Jetstack charts repository](https://github.com/jetstack/jetstack-charts).
@@ -602,7 +609,7 @@ page if a step is missing or if it is outdated.
4. Merge the PR
5. Check that the [cert-manager Helm chart is visible on ArtifactHUB](https://artifacthub.io/packages/helm/cert-manager/cert-manager).
-16. **(final + patch releases)** Merge the 4 Website PRs:
+15. **(final + patch releases)** Merge the 4 Website PRs:
1. Merge the PRs "Release Notes", "Upgrade Notes", and "Freeze And Bump
Versions" that you have created previously.
From d2569b794ccaecd3ca191ba8ed8684aba5300d8e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Fri, 1 Sep 2023 18:52:13 +0200
Subject: [PATCH 07/12] release-process: explain that you need to push the
branch
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index 0b0d02f15e8..0795302b8eb 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -436,8 +436,16 @@ page if a step is missing or if it is outdated.
[how-are-versions-of-a-sub-module-managed]: https://stackoverflow.com/questions/60601011/how-are-versions-of-a-sub-module-managed/60601402#60601402
- Then, open a PR to merge that change and go back to the release branch
- with the following commands:
+ Then, push the branch to your fork of cert-manager. For example:
+
+ ```bash
+ # Must be run from the cert-manager repo folder.
+ gh repo fork --remote-name fork
+ git push -u fork "update-cmd/ctl/$RELEASE_VERSION"
+ ```
+
+ Then, open a PR to merge that change and go back to the release branch with
+ the following commands:
```bash
gh pr create \
From 42faf39bcd8fb4b7dbe50e9d5f56e744e4de4105 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Fri, 1 Sep 2023 18:57:31 +0200
Subject: [PATCH 08/12] release-process: fixes
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index 0795302b8eb..f9563462a96 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -461,11 +461,11 @@ page if a step is missing or if it is outdated.
EOF
```
- Finally, get back to the main tag:
+ Finally, get back to the branch you were on initially:
- ```bash
- git checkout $RELEASE_VERSION
- ```
+ ```bash
+ git checkout $BRANCH
+ ```
10. In this section, we will be creating the description for the GitHub Release.
From 394bbbece45348dd69bd068d47e60d0cc3294ce6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Fri, 1 Sep 2023 20:00:34 +0200
Subject: [PATCH 09/12] release-process: fix spelling
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
.spelling | 1 +
content/docs/contributing/release-process.md | 3 +--
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/.spelling b/.spelling
index a8e5948b8be..4d14dc25071 100644
--- a/.spelling
+++ b/.spelling
@@ -102,6 +102,7 @@ CertificateSecretTemplate
CertificateSigningRequest
CertificateSigningRequests
Changelog
+changelog
ChartMuseum
CloudDNS
CloudFlare
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index f9563462a96..878553a5e88 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -203,8 +203,7 @@ page if a step is missing or if it is outdated.
`github-release-description.md`).
2. Remove the "Dependencies" section.
3. For each bullet point in the Markdown file, read the changelog entry and
- check that it follows the [release-note
- guidelines](../contributing/contributing-flow.md#release-note-guidelines).
+ check that it follows the [release-note guidelines](../contributing/contributing-flow.md#release-note-guidelines).
If you find a changelog entry that doesn't follow the guidelines, then:
- Go to that PR and edit the PR description to change the contents of the
`release-note` block.
From ee3017f31d1fda74b3e4fceeb90245710cd1fc94 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Tue, 5 Sep 2023 20:52:49 +0200
Subject: [PATCH 10/12] release-process: the "find" trick was completely
broken!
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index 878553a5e88..87839cb85f7 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -269,17 +269,17 @@ page if a step is missing or if it is outdated.
```
4. (**final + patch release of the latest minor version**) Bump all versions
- present in installation instructions. To find these versions:
+ present in installation instructions. To update these versions:
```bash
- find ./content/docs/installation -name '*.md' -not -path '*/upgrad**' -and -not -path '*supported-releases.md' -exec sed -i.bak 's/1.11./1.12.0/g' '{}' \;
+ sed -i.bak 's/1.12.[0-9]/1.12.4/g' content/docs/installation/{README.md,code-signing.md,helm.md,kubectl.md,operator-lifecycle-manager.md}
rm -f **/*.bak
```
To check that all mentions of that version are gone, run:
```bash
- grep -R -n -F 'v1.11.' content/docs/installation
+ grep -R -n -F 'v1.11.[0-9]' content/docs/installation
```
5. (**final release only**) Freeze the `docs/` folder by creating a copy ,
From 670e8b7816d93aaf080a8e5c3683205a9ab3778a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Wed, 13 Sep 2023 14:00:41 +0200
Subject: [PATCH 11/12] release-process: -E should come before -e
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Otherwise, -E doens't apply to the sed commands
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index 87839cb85f7..05d74eda5aa 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -218,10 +218,9 @@ page if a step is missing or if it is outdated.
`@maelvls`) with actual links using the following command:
```bash
- sed \
+ sed -E \
-e 's$#([0-9]+)$[#\1](https://github.com/cert-manager/cert-manager/pull/\1)$g' \
-e 's$@(\w+)$[@\1](https://github.com/\1)$g' \
- -E \
github-release-description.md >release-notes.md
```
From 3acae8a43ff03abc042eab24737c7effa97ede85 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Valais?=
Date: Fri, 15 Sep 2023 13:58:03 +0200
Subject: [PATCH 12/12] release-process: remove duplicate explanation about
github token
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Maël Valais
---
content/docs/contributing/release-process.md | 6 +-----
1 file changed, 1 insertion(+), 5 deletions(-)
diff --git a/content/docs/contributing/release-process.md b/content/docs/contributing/release-process.md
index 05d74eda5aa..cedd546f40f 100644
--- a/content/docs/contributing/release-process.md
+++ b/content/docs/contributing/release-process.md
@@ -494,15 +494,11 @@ page if a step is missing or if it is outdated.
--output github-release-description.md
```
-
- The GitHub token **does not need any scope**. The token is required
- only to avoid rate-limits imposed on anonymous API users.
-
-
The GitHub token **does not need any scope**. The token is required
only to avoid rate-limits imposed on anonymous API users.
+
3. Add a one-sentence summary at the top.
4. **(final release only)** Write the "Community" section, following the example of past releases such as [v1.12.0](https://github.com/cert-manager/cert-manager/releases/tag/v1.12.0). If there are any users who didn't make code contributions but helped in other ways (testing, PR discussion, etc), be sure to thank them here!