Skip to content

Add CI check for updated helm docs #6696

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Feb 1, 2024
Merged

Add CI check for updated helm docs #6696

merged 1 commit into from
Feb 1, 2024

Conversation

SgtCoDFish
Copy link
Member

Pull Request Motivation

This differs slightly from, say, LICENSE verification, because helm-tool modifies its input. So we first copy the template we already have and modify the copied version.

Kind

/kind bug

Release Note

Add verification step to ensure that helm docs are updated

@jetstack-bot jetstack-bot added kind/bug Categorizes issue or PR as related to a bug. release-note Denotes a PR that will be considered when it comes time to generate release notes. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 1, 2024
@SgtCoDFish
Copy link
Member Author

I'm expecting that the new test should fail, because #6695 hasn't merged yet so the docs are out of date!

@SgtCoDFish
Copy link
Member Author

/cherry-pick release-1.14

@jetstack-bot
Copy link
Contributor

@SgtCoDFish: once the present PR merges, I will cherry-pick it on top of release-1.14 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@SgtCoDFish
Copy link
Member Author

/test pull-cert-manager-master-e2e-v1-28-upgrade

@SgtCoDFish
Copy link
Member Author

/test pull-cert-manager-master-make-test

@SgtCoDFish SgtCoDFish force-pushed the fixhelmreadmeci branch 5 times, most recently from 434f7aa to b259a9f Compare February 1, 2024 11:36
@jetstack-bot jetstack-bot added the area/deploy Indicates a PR modifies deployment configuration label Feb 1, 2024
@SgtCoDFish
Copy link
Member Author

Confirmed that make-test now fails when values.yaml has been modified. Also added a check that the template isn't dirty so if there's something which updates the template in CI we don't accidentally check against an up-to-date version.

I'll remove the WIP commit which introduces the break, and the tests should start passing again

This was referenced Feb 1, 2024
Merged
Merged
@inteon
Copy link
Member

inteon commented Feb 1, 2024

/approve
/lgtm

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Feb 1, 2024
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: inteon

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

@jetstack-bot jetstack-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 1, 2024
@inteon
Copy link
Member

inteon commented Feb 1, 2024

@SgtCoDFish
CI is failing with this error: deploy/charts/cert-manager/README.template.md seems to be out of date; update with 'make update-helm-docs'

@jetstack-bot jetstack-bot removed the lgtm Indicates that a PR is ready to be merged. label Feb 1, 2024
@SgtCoDFish
add CI check for updated helm docs
8c13697 
also updates helm docs!

Signed-off-by: Ashley Davis <ashley.davis@venafi.com>
@SgtCoDFish
Copy link
Member Author

CI is failing with this error: deploy/charts/cert-manager/README.template.md seems to be out of date; update with 'make update-helm-docs'

Looks like it was this PR which changed the values but didn't update the README: #6699

Good test case I guess 😁

@inteon
Copy link
Member

inteon commented Feb 1, 2024

/lgtm

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Feb 1, 2024
@SgtCoDFish SgtCoDFish merged commit cd1ad06 into cert-manager:master Feb 1, 2024
@SgtCoDFish SgtCoDFish deleted the fixhelmreadmeci branch February 1, 2024 15:48
@jetstack-bot
Copy link
Contributor

@SgtCoDFish: #6696 failed to apply on top of branch "release-1.14":

Applying: add CI check for updated helm docs
.git/rebase-apply/patch:16: trailing whitespace.
`prometheus.podmonitor.enabled`, 'prometheus.io' annotations are added to the cert-manager Deployment  
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	deploy/charts/cert-manager/README.template.md
M	make/ci.mk
Falling back to patching base and 3-way merge...
Auto-merging make/ci.mk
Auto-merging deploy/charts/cert-manager/README.template.md
CONFLICT (content): Merge conflict in deploy/charts/cert-manager/README.template.md
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 add CI check for updated helm docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-1.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@SgtCoDFish
Copy link
Member Author

SgtCoDFish commented Feb 1, 2024 •
edited
Loading

Expect that the auto backport will fail now I've included the change for #6699 - I'll manually backport if needed

EDIT: as expected!

@SgtCoDFish SgtCoDFish mentioned this pull request Feb 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/deploy Indicates a PR modifies deployment configuration dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@SgtCoDFish @jetstack-bot @inteon