Skip to content
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

Conversation

wallrj
Copy link
Member

@wallrj wallrj commented Sep 27, 2024

@cert-manager-prow cert-manager-prow bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 27, 2024
Copy link

netlify bot commented Sep 27, 2024

Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit dba5531
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager/deploys/66fbb8f02be96c0008efc397
😎 Deploy Preview https://deploy-preview-1568--cert-manager.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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`
Copy link
Contributor

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`
Copy link
Member

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:

Screenshot 2024-09-27 at 18 31 35

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:

Suggested change
> 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)

Copy link
Contributor

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

Copy link
Member Author

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.

@wallrj wallrj force-pushed the update-breaking-changes-details-1.16 branch from ef02ee5 to f1a2240 Compare October 1, 2024 08:45
@wallrj wallrj force-pushed the update-breaking-changes-details-1.16 branch from f1a2240 to dba5531 Compare October 1, 2024 08:55
@wallrj wallrj requested a review from SgtCoDFish October 1, 2024 08:59
Copy link
Member

@SgtCoDFish SgtCoDFish left a 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!

@cert-manager-prow
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@cert-manager-prow cert-manager-prow bot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Oct 1, 2024
@cert-manager-prow cert-manager-prow bot merged commit 8c722ec into cert-manager:release-next Oct 1, 2024
7 checks passed
@wallrj wallrj deleted the update-breaking-changes-details-1.16 branch October 1, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants