diff --git a/.spelling b/.spelling index 34740373cd5..85be485a975 100644 --- a/.spelling +++ b/.spelling @@ -13,6 +13,7 @@ apiserver APIService APIServices AppRole +ArtifactHUB AWS allowlist awspca diff --git a/content/en/docs/contributing/release-process.md b/content/en/docs/contributing/release-process.md index ffe1315caa4..a7f3532189f 100644 --- a/content/en/docs/contributing/release-process.md +++ b/content/en/docs/contributing/release-process.md @@ -364,11 +364,10 @@ page if a step is missing or if it is outdated. ```

- ⏰ At this stage, there will be a draft release on GitHub and a live - release on our ChartMuseum (https://charts.jetstack.io/index.yaml). - So you must now complete the release process quickly; otherwise, users - of the latest release on our ChartMuseum instance will encounter errors - because the manual CRD install URL will not be available yet. + ⏰ Upon completion there will be: + + 1. [A draft release of cert-manager on GitHub](https://github.com/jetstack/cert-manager/releases). + 2. [A pull request containing the new Helm chart](https://github.com/jetstack/jetstack-charts/pulls).

5. While the build is running, send a fourth Slack message in reply to @@ -391,10 +390,22 @@ page if a step is missing or if it is outdated. 3. Click "Publish" to make the GitHub release live. This will create a Git tag automatically. -9. **(final release only)** Add the new final release to the +9. 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). + The `cmrel publish --nomock` step (above) will have created a PR in this repository which you now have to review and merge, as follows: + + 1. [Visit the pull request](https://github.com/jetstack/jetstack-charts/pulls) + 2. Review the changes + 3. Fix any failing checks + 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). + +10. **(final release only)** Add the new final release to the [supported-releases](/docs/installation/supported-releases/) page. -10. Post a Slack message as an answer to the first message. Toggle the check +11. Post a Slack message as an answer to the first message. Toggle the check box "Also send to `#cert-manager-dev`" so that the message is well visible. Also cross-post the message on `#cert-manager`. @@ -402,7 +413,7 @@ page if a step is missing or if it is outdated. https://github.com/jetstack/cert-manager/releases/tag/v1.0.0 🎉

-11. **(final release only)** Show the release to the world: +12. **(final release only)** Show the release to the world: 1. Send an email to [`cert-manager-dev@googlegroups.com`](https://groups.google.com/g/cert-manager-dev) @@ -413,7 +424,7 @@ page if a step is missing or if it is outdated. ([example](https://twitter.com/MaartjeME/status/1286327362121084928)) and make sure [@JetstackHQ](https://twitter.com/JetstackHQ) retweets it. -12. Proceed to the post-release steps: +13. Proceed to the post-release steps: 1. **(final release only)** Add the new final release to the [supported-releases](/docs/installation/supported-releases/) page. diff --git a/content/en/docs/installation/upgrading/upgrading-1.3-1.4.md b/content/en/docs/installation/upgrading/upgrading-1.3-1.4.md new file mode 100644 index 00000000000..cc46d487954 --- /dev/null +++ b/content/en/docs/installation/upgrading/upgrading-1.3-1.4.md @@ -0,0 +1,9 @@ +--- +title: "Upgrading from v1.3 to v1.4" +linkTitle: "v1.3 to v1.4" +weight: 820 +type: "docs" +--- + +When upgrading from `v1.3` to `v1.4`, no special upgrade steps are required 🎉. +From here on you can follow the [regular upgrade process](../). diff --git a/scripts/verify-lint b/scripts/verify-lint index d4f24cbbc76..1dcbc3a2684 100755 --- a/scripts/verify-lint +++ b/scripts/verify-lint @@ -26,13 +26,13 @@ cd "${REPO_ROOT}" echo "+++ Running 'alex' - ignoring any failures" "${REPO_ROOT}/node_modules/.bin/alex" \ - content/ || true + content/ || true echo "+++ Running remark" "${REPO_ROOT}/node_modules/.bin/remark" \ - --rc-path ".remarkrc" \ - --frail \ - content/ + --rc-path ".remarkrc" \ + --frail \ + content/ echo "+++ Running spell check" "${REPO_ROOT}/node_modules/.bin/mdspell" \ @@ -55,4 +55,16 @@ echo "+++ Running spell check" "!content/en/v1.1-docs/reference/api-docs.md" \ "!content/en/v1.2-docs/reference/api-docs.md" \ "!content/en/v1.3-docs/reference/api-docs.md" \ - "!content/en/next-docs/reference/api-docs.md" + "!content/en/next-docs/**/*.md" + +# About "!content/en/next-docs/**/*.md": +# +# mdspell can fail on master due to words that have been added to the +# release-next branch and aren't on master yet. Since we pull the release-next +# branch into content/en/next-docs, the yet-to-be-ignored words are unknown to +# mdspell. +# +# As an example, the PR https://github.com/cert-manager/website/pull/570 added +# the new spellings "andreas-p" and "renewBefore" to the release-next branch. +# After the merge, all builds on master started failing since "andreas-p" and +# "renewBefore" were not present on the master branch's .spelling file.