[master] Freeze 1.19 and bump versions before merging release-next#2002
[master] Freeze 1.19 and bump versions before merging release-next#2002
Conversation
Signed-off-by: Maël Valais <mael@vls.dev>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for cert-manager ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Prepares the website for the cert-manager v1.20.0 release by freezing the v1.19 documentation snapshot and bumping the site’s “latest version”/release metadata accordingly.
Changes:
- Freeze and add
content/v1.19-docs/**documentation snapshot (tutorials, installation, concepts, etc.) - Bump the global
cert_manager_latest_versiontov1.20.0 - Update release documentation and CLI reference outputs to match the new release
Reviewed changes
Copilot reviewed 93 out of 126 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| content/v1.19-docs/tutorials/acme/pomerium-ingress.md | Adds v1.19 snapshot tutorial content for Pomerium ingress |
| content/v1.19-docs/tutorials/acme/migrating-from-kube-lego.md | Adds v1.19 snapshot tutorial page |
| content/v1.19-docs/tutorials/acme/http-validation.md | Adds v1.19 snapshot tutorial page |
| content/v1.19-docs/tutorials/acme/example/staging-issuer.yaml | Adds v1.19 tutorial example manifest |
| content/v1.19-docs/tutorials/acme/example/service.yaml | Adds v1.19 tutorial example manifest |
| content/v1.19-docs/tutorials/acme/example/production-issuer.yaml | Adds v1.19 tutorial example manifest |
| content/v1.19-docs/tutorials/acme/example/pomerium-values.yaml | Adds v1.19 tutorial example values file |
| content/v1.19-docs/tutorials/acme/example/pomerium-staging-issuer.yaml | Adds v1.19 tutorial example issuer |
| content/v1.19-docs/tutorials/acme/example/pomerium-production-issuer.yaml | Adds v1.19 tutorial example issuer |
| content/v1.19-docs/tutorials/acme/example/pomerium-certificates.yaml | Adds v1.19 tutorial example certificates |
| content/v1.19-docs/tutorials/acme/example/ingress.yaml | Adds v1.19 tutorial example ingress (non-TLS) |
| content/v1.19-docs/tutorials/acme/example/ingress-tls.yaml | Adds v1.19 tutorial example ingress (TLS) |
| content/v1.19-docs/tutorials/acme/example/ingress-tls-final.yaml | Adds v1.19 tutorial example ingress (TLS prod) |
| content/v1.19-docs/tutorials/acme/example/deployment.yaml | Adds v1.19 tutorial example deployment |
| content/v1.19-docs/tutorials/acme/dns-validation.md | Adds v1.19 snapshot tutorial page |
| content/v1.19-docs/tutorials/README.md | Adds v1.19 tutorials index |
| content/v1.19-docs/trust/trust-manager/installation.md | Adds v1.19 trust-manager install page |
| content/v1.19-docs/trust/README.md | Adds v1.19 trust section overview |
| content/v1.19-docs/troubleshooting/acme.md | Adds v1.19 troubleshooting guide content |
| content/v1.19-docs/troubleshooting/README.md | Adds v1.19 troubleshooting section index |
| content/v1.19-docs/reference/tls-terminology.md | Adds v1.19 reference page |
| content/v1.19-docs/reference/README.md | Adds v1.19 reference section index |
| content/v1.19-docs/policy/issuing.md | Adds v1.19 policy documentation |
| content/v1.19-docs/policy/defaulting.md | Adds v1.19 policy documentation |
| content/v1.19-docs/policy/approval/approver-policy/installation.md | Adds v1.19 approver-policy install docs |
| content/v1.19-docs/policy/approval/README.md | Adds v1.19 approval policy docs |
| content/v1.19-docs/policy/README.md | Adds v1.19 policy section index |
| content/v1.19-docs/installation/upgrade.md | Adds v1.19 upgrade docs |
| content/v1.19-docs/installation/uninstall.md | Adds v1.19 uninstall docs |
| content/v1.19-docs/installation/reinstall.md | Adds v1.19 reinstall docs |
| content/v1.19-docs/installation/kubectl.md | Adds v1.19 kubectl install docs |
| content/v1.19-docs/installation/helm.md | Adds v1.19 Helm install docs |
| content/v1.19-docs/installation/continuous-deployment-and-gitops.md | Adds v1.19 GitOps/Flux guidance |
| content/v1.19-docs/installation/configuring-components.md | Adds v1.19 component config docs |
| content/v1.19-docs/installation/compatibility.md | Adds v1.19 compatibility notes |
| content/v1.19-docs/installation/code-signing.md | Adds v1.19 signing/verification docs |
| content/v1.19-docs/installation/README.md | Adds v1.19 installation section index |
| content/v1.19-docs/getting-started/README.md | Adds v1.19 getting started page |
| content/v1.19-docs/faq/README.md | Adds v1.19 FAQ page |
| content/v1.19-docs/devops-tips/syncing-secrets-across-namespaces.md | Adds v1.19 devops tip page |
| content/v1.19-docs/devops-tips/scaling-cert-manager.md | Adds v1.19 devops tip page |
| content/v1.19-docs/devops-tips/prometheus-metrics.md | Adds v1.19 metrics page |
| content/v1.19-docs/devops-tips/backup.md | Adds v1.19 backup/restore docs |
| content/v1.19-docs/configuration/selfsigned.md | Adds v1.19 issuer configuration doc |
| content/v1.19-docs/configuration/acme/http01/externalloadbalancer.md | Adds v1.19 ACME HTTP-01 doc |
| content/v1.19-docs/configuration/acme/dns01/webhook.md | Adds v1.19 DNS01 webhook solver doc |
| content/v1.19-docs/configuration/acme/dns01/rfc2136.md | Adds v1.19 RFC2136 solver doc |
| content/v1.19-docs/configuration/acme/dns01/google.md | Adds v1.19 CloudDNS solver doc |
| content/v1.19-docs/configuration/acme/dns01/digitalocean.md | Adds v1.19 DigitalOcean solver doc |
| content/v1.19-docs/configuration/acme/dns01/cloudflare.md | Adds v1.19 Cloudflare solver doc |
| content/v1.19-docs/configuration/acme/dns01/akamai.md | Adds v1.19 Akamai solver doc |
| content/v1.19-docs/configuration/acme/dns01/acme-dns.md | Adds v1.19 acme-dns solver doc |
| content/v1.19-docs/configuration/acme/dns01/README.md | Adds v1.19 DNS01 overview doc |
| content/v1.19-docs/configuration/README.md | Adds v1.19 configuration section index |
| content/v1.19-docs/concepts/webhook.md | Adds v1.19 concepts page |
| content/v1.19-docs/concepts/issuer.md | Adds v1.19 concepts page |
| content/v1.19-docs/concepts/ca-injector.md | Adds v1.19 concepts page |
| content/v1.19-docs/concepts/acme-orders-challenges.md | Adds v1.19 concepts page |
| content/v1.19-docs/concepts/README.md | Adds v1.19 concepts index |
| content/v1.19-docs/cli/webhook.md | Adds v1.19 CLI reference output |
| content/v1.19-docs/cli/startupapicheck.md | Adds v1.19 CLI reference output |
| content/v1.19-docs/cli/controller.md | Adds v1.19 CLI reference output |
| content/v1.19-docs/cli/cmctl.md | Adds v1.19 CLI reference output |
| content/v1.19-docs/cli/cainjector.md | Adds v1.19 CLI reference output |
| content/v1.19-docs/cli/acmesolver.md | Adds v1.19 CLI reference output |
| content/v1.19-docs/cli/README.md | Adds v1.19 CLI docs index |
| content/v1.19-docs/README.md | Adds v1.19 docs root landing page |
| content/docs/variables.json | Bumps cert_manager_latest_version to v1.20.0 |
| content/docs/releases/README.md | Updates release tables and dates for 1.20/1.21 |
| content/docs/cli/webhook.md | Updates webhook CLI flags output for new release |
| content/docs/cli/controller.md | Updates controller CLI flags output for new release |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| kind: Ingress | ||
| metadata: | ||
| name: kuard | ||
| annotations: {} |
There was a problem hiding this comment.
The annotations: {} line makes this YAML invalid because you can’t add child keys/comments at a deeper indentation under an explicit empty map value. Replace it with a normal mapping (e.g., annotations:) and then include the commented example key below it (or remove the comment).
| annotations: {} | |
| annotations: |
| url: https://authenticate.example.com | ||
| identityProvider: | ||
| provider: ${YOUR_IdP} | ||
| secret: pomerium/idp | ||
| # certificates: | ||
| # - pomerium/pomerium-proxy-tls |
There was a problem hiding this comment.
This example manifest’s YAML indentation is inconsistent (url, provider, secret are indented too far), which will break copy/paste usage. Adjust indentation so nested keys are consistently indented by two spaces under their parent.
| url: https://authenticate.example.com | |
| identityProvider: | |
| provider: ${YOUR_IdP} | |
| secret: pomerium/idp | |
| # certificates: | |
| # - pomerium/pomerium-proxy-tls | |
| url: https://authenticate.example.com | |
| identityProvider: | |
| provider: ${YOUR_IdP} | |
| secret: pomerium/idp | |
| # certificates: | |
| # - pomerium/pomerium-proxy-tls |
| # - pomerium/pomerium-proxy-tls | ||
| ``` | ||
|
|
||
| Replace `${YOUR_IdP}` with your identity provider. Apply with `kubectl -f`. |
There was a problem hiding this comment.
The command fragment kubectl -f is not valid; it should specify an operation (e.g., kubectl apply -f <file>). Updating this avoids readers hitting a hard failure when following the instructions.
| Replace `${YOUR_IdP}` with your identity provider. Apply with `kubectl -f`. | |
| Replace `${YOUR_IdP}` with your identity provider. Apply with `kubectl apply -f <filename>.yaml`. |
| You can download and edit the example and apply it with `kubectl apply -f`, or edit, and apply the custom resource in one command: | ||
|
|
||
| ```bash | ||
| kubectl create --edit -f https://raw.githubusercontent.com/cert-manager/website/master/content/docs/tutorials/acme/example/pomerium-staging-issuer.yaml |
There was a problem hiding this comment.
These URLs point to master, which means the v1.19 docs can silently drift as master changes. For a frozen versioned docs snapshot, link to a versioned branch/tag (e.g., release-1.19) or use relative links within the v1.19 content tree.
| ``` | ||
|
|
||
| ```bash | ||
| kubectl create --edit -f https://raw.githubusercontent.com/cert-manager/website/master/content/docs/tutorials/acme/example/pomerium-production-issuer.yaml |
There was a problem hiding this comment.
These URLs point to master, which means the v1.19 docs can silently drift as master changes. For a frozen versioned docs snapshot, link to a versioned branch/tag (e.g., release-1.19) or use relative links within the v1.19 content tree.
| In `v1.3.0` , as part of our work towards [policy | ||
| implementation](https://github.com/cert-manager/cert-manager/pull/3727) we | ||
| introduced identity fields for `CertificateRequest` resources where, at a time | ||
| of creation, `cert-mananager`'s webhook updates `CertificateRequest`'s spec |
There was a problem hiding this comment.
Correct spelling of 'cert-mananager' to 'cert-manager'.
| of creation, `cert-mananager`'s webhook updates `CertificateRequest`'s spec | |
| of creation, `cert-manager`'s webhook updates `CertificateRequest`'s spec |
| @@ -0,0 +1,24 @@ | |||
| apiVersion: networking.k8s.io/v1 | |||
There was a problem hiding this comment.
There’s trailing whitespace after the apiVersion value. Removing trailing spaces helps keep generated YAML clean and avoids noisy diffs/linters failing in downstream tooling.
| apiVersion: networking.k8s.io/v1 | |
| apiVersion: networking.k8s.io/v1 |
| annotations: | ||
| cert-manager.io/issuer: letsencrypt-staging | ||
| tls: | ||
| secretName: authenticate.localhost.pomerium.io-tls |
There was a problem hiding this comment.
This line has trailing whitespace at the end. Removing it avoids accidental formatting issues and keeps diffs stable.
| secretName: authenticate.localhost.pomerium.io-tls | |
| secretName: authenticate.localhost.pomerium.io-tls |
| ### 1. Update Helm Repository | ||
|
|
||
| Helm is the easiest way to install trust-manager and comes with a publicly trusted certificate bundle package | ||
| (for the`useDefaultCAs` source) derived from Debian containers. |
There was a problem hiding this comment.
Inline code formatting is missing spaces before backticks in a couple places (the\useDefaultCAs`andwhere`Secret`s`). Add a space so the text renders correctly and remains readable.
| (for the`useDefaultCAs` source) derived from Debian containers. | |
| (for the `useDefaultCAs` source) derived from Debian containers. |
| One of the more important configuration options you might need to consider at install time is which "trust namespace" to use, | ||
| which can be set via the Helm value `app.trust.namespace`. | ||
|
|
||
| By default, the trust namespace is the only namespace where`Secret`s will be read. This restriction is in place |
There was a problem hiding this comment.
Inline code formatting is missing spaces before backticks in a couple places (the\useDefaultCAs`andwhere`Secret`s`). Add a space so the text renders correctly and remains readable.
I messed up with #1998 as I merged it to
release-nextinstead ofmaster. The release-process.md instructions aren't super clear...This is the "Prepare the Website Bump Versions" step from the cert-manager release process (step 5, for final + patch releases):
./scripts/freeze-docs 1.19content/docs/releases/README.md:scripts/gendocs/generate-new-import-path-docsfrom release-1.19 to release-1.20./scripts/gendocs/generateRelated: