-
Notifications
You must be signed in to change notification settings - Fork 334
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update breaking changes details 1.16 #1568
Update breaking changes details 1.16 #1568
Conversation
cert-manager#1520 (review) Signed-off-by: Richard Wall <[email protected]>
✅ Deploy Preview for cert-manager ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
avoiding typos and mistakes in the default values file. | ||
|
||
> ⚠️ Helm schema validation may reject your existing Helm values files if they contain typos or unrecognized fields. | ||
> You can use `helm template cert-manager --repo https://charts.jetstack.io --version 1.16.x --values values.cert-manager.yaml` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the 1.16.x
bit doesn't work...
Today, I can use:
helm template cert-manager --repo https://charts.jetstack.io --version 1.16.0-beta.0 --values values.yaml
But, as a reader, I expect a command like this to work as is in the docs, and not require guessing.
avoiding typos and mistakes in the default values file. | ||
|
||
> ⚠️ Helm schema validation may reject your existing Helm values files if they contain typos or unrecognized fields. | ||
> You can use `helm template cert-manager --repo https://charts.jetstack.io --version 1.16.x --values values.cert-manager.yaml` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: Having the command in just backticks like this means it gets split across lines:
That makes it harder to copy and I think a lot of people upgrading will want to copy it!
I'd suggest having it in triple backticks instead so it's rendered as a code block:
> You can use `helm template cert-manager --repo https://charts.jetstack.io --version 1.16.x --values values.cert-manager.yaml` | |
> ```bash | |
> helm template cert-manager --repo https://charts.jetstack.io --version 1.16.x --values values.cert-manager.yaml | |
> ``` |
(the suggestion might not work as-is, but you get the idea)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we know if users actually need to use that much wording?
For me, this was more than enough (as I had already adjusted my Chart.yaml
file to use the newer chart repo):
helm template cert-manager . --values values.yaml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SgtCoDFish Done. And added an example of an error.
@jsoref You're suggested command would only work for your specific sub-chart use-case, right? For general users it is better to state the repo URL (otherwise they'd need to run helm repo update
first) and it's better to state the version otherwise they may not be testing against the cert-manager 1.16 release.
I wrote --version 1.16.x
deliberately, because I thought it would continue to work for future 1.16 patch releases.
It does not work with 1.16 pre-releases without an additional --devel
flag.
So I've added an explicit version variable instead which should be updated with future patch releases.
ef02ee5
to
f1a2240
Compare
Signed-off-by: Richard Wall <[email protected]>
f1a2240
to
dba5531
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/approve
I think this looks good. I don't actually think we need to update the --version
unless we notice a major bug in the chart for 1.16.1, since this is just to check that pre-existing values work. But no major thing either way.
Thanks for this!
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: SgtCoDFish The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
8c722ec
into
cert-manager:release-next
Preview: https://deploy-preview-1568--cert-manager.netlify.app/docs/releases/release-notes/release-notes-1.16/#breaking-changes