You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add release-notes generator script and update release docs
- Add scripts/release-notes Go tool that generates and maintains
release notes using k8s.io/release changelog extraction
- Add make generate-release-notes target with CERT_MANAGER_VERSION
variable; the tool auto-detects the best end revision (tag →
release branch → master) so it works before the tag is created
- Update release process docs to use make generate-release-notes
in step 4 (prepare release notes PR, can be done ahead of time)
and step 11 (re-run after tag is created if needed)
- Remove dependency on the separately-installed k8s release-notes CLI
- Update release-notes-1.18.md with auto-generated content
- Add content/docs/releases/release-notes/.spelling for version strings
Signed-off-by: Richard Wall <richard.wall@cyberark.com>
6. Make sure `gcloud` points to the cert-manager-release project:
86
+
5. Make sure `gcloud` points to the cert-manager-release project:
93
87
94
88
```bash
95
89
gcloud config set project cert-manager-release
96
90
export CLOUDSDK_CORE_PROJECT=cert-manager-release # this is used by cmrel
97
91
```
98
92
99
-
7. Get a GitHub access token [here](https://github.com/settings/tokens)
100
-
with no scope ticked. It is used only by the `release-notes` CLI to
101
-
avoid API rate limiting since it will go through all the PRs one by one.
93
+
6. Get a GitHub access token [here](https://github.com/settings/tokens)
94
+
with no scope ticked. It is required only to avoid API rate limiting
95
+
when generating release notes.
102
96
103
-
8. Ensure that you have `gsutil` installed; it's part of the Google Cloud SDK.
97
+
7. Ensure that you have `gsutil` installed; it's part of the Google Cloud SDK.
104
98
105
-
9. Ensure you have `cosign` installed. See [the cosign installation instructions](https://docs.sigstore.dev/cosign/system_config/installation/).
99
+
8. Ensure you have `cosign` installed. See [the cosign installation instructions](https://docs.sigstore.dev/cosign/system_config/installation/).
106
100
107
-
10. Ensure you have permissions to push to the OCI Helm chart registry, `quay.io/jetstack/charts`. You may need to run commands from [Helm's documentation](https://helm.sh/docs/topics/registries/#commands-for-working-with-registries).
101
+
9. Ensure you have permissions to push to the OCI Helm chart registry, `quay.io/jetstack/charts`. You may need to run commands from [Helm's documentation](https://helm.sh/docs/topics/registries/#commands-for-working-with-registries).
108
102
Specifically, you will need to have run `helm registry login -u=USERNAME -p=PASSWORD quay.io` to authenticate with the registry.
109
103
Credentials can be obtained from the `quay.io` web UI if you're already a member of the `jetstack` organization on Quay.
110
104
@@ -139,45 +133,13 @@ page if a step is missing or if it is outdated.
139
133
140
134
[^1]: One or more "patch pre-releases" may be created to allow voluntary community testing of a bug fix or security fix before the fix is made generally available. The suffix `-beta` must be used for patch pre-releases.
141
135
142
-
2. Set the 4 environment variables by copying the following snippet in your
143
-
shell table:
136
+
2. Set the `RELEASE_VERSION` environment variable by pasting the following snippet into your
137
+
shell:
144
138
145
139
```bash
146
140
export RELEASE_VERSION="v1.3.0-alpha.0"
147
-
export START_TAG="v1.2.0"
148
-
export END_REV="release-1.3"
149
-
export BRANCH="release-1.3"
150
141
```
151
142
152
-
> **Note:** To help you fill in the correct values, use the following
153
-
> examples:
154
-
>
155
-
> | Variable | Example 1 | Example 2 | Example 2 | Example 3 | Example 4 |
0 commit comments