docs: remove dynamic variable from frozen release notes and upgrade guides#2192
Merged
cert-manager-prow[bot] merged 1 commit intoJul 1, 2026
Conversation
…uides The [[VAR::cert_manager_latest_version]] template variable resolves to the current latest version of cert-manager. When used inside frozen release notes and upgrade guides for older releases, this produces confusing instructions such as "When upgrading to cert-manager 1.19, use the latest patch version: v1.20.3." Replace the variable with static text: - upgrading-1.18-1.19.md: "use the latest patch version of cert-manager 1.19" - release-notes-1.16.md: use `v1.16.x` in the helm template command example - release-notes-1.19.md: "use the latest patch version of cert-manager 1.19" Fixes: cert-manager#2105 Signed-off-by: Richard Wall <richard.wall@cyberark.com>
cert-manager-prow
Bot
added
dco-signoff: yes
✅ Deploy Preview for cert-manager ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Member
Author
|
@joebowbeer — this should fix the issue you reported. Please take a look at the preview links in the description and let us know if the wording looks right to you. |
wallrj-cyberark
added
approved
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED Approval requirements bypassed by manually added approval. This pull-request has been approved by: joebowbeer The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Preview:
Problem
The
[[VAR::cert_manager_latest_version]]template variable resolves to thecurrent latest cert-manager version (presently
v1.20.3). When this variableappears inside frozen release notes and upgrade guides for older releases, it
produces confusing instructions such as:
Reported in #2105 (and originally noted in #1433).
Fix
Replace the dynamic variable with static text that does not embed a specific
patch version, so the wording stays accurate without requiring future updates:
upgrading-1.18-1.19.md: heading and body now say "use the latest patch version of cert-manager 1.19"release-notes-1.16.md:helm templateexample usesv1.16.xrelease-notes-1.19.md: body now says "use the latest patch version of cert-manager 1.19"Testing
Verified with
grepthat no[[VAR::cert_manager_latest_version]]referencesremain in
content/docs/releases/.