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

Add linting job #432

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

marcofranssen
Copy link
Contributor

@marcofranssen marcofranssen commented Nov 30, 2022

Description of the change

This PR checks:

  • Lock files are updated
  • README.md are updated

Existing or Associated Issue(s)

Aligns with the CONTRIBUTING.md, which wasn't followed in a bunch of PRs, causing docs to be out of sync.

Additional Information

Checklist

  • Chart version bumped in Chart.yaml according to semver. Where applicable, update and bump the versions in any associated umbrella chart
  • Variables are documented in the values.yaml and added to the README.md. The helm-docs utility can be used to generate the necessary content. Use helm-docs --dry-run to preview the content.
  • JSON Schema generated.
  • List tests pass for Chart using the Chart Testing tool and the ct lint command.

@marcofranssen marcofranssen force-pushed the check-lock-file branch 10 times, most recently from e2a6819 to 4332b6c Compare November 30, 2022 12:33
@marcofranssen marcofranssen force-pushed the check-lock-file branch 2 times, most recently from fc55dcc to 7566167 Compare January 2, 2023 08:43
@marcofranssen
Copy link
Contributor Author

I see many of the charts have outdated documentation again, since last time I made some contributions (and therefore also the CONTRIBUTING.md was not followed). Using this PR we should have an automated safety net in place to prevent this in the future.

How do you want to go about merging this PR vs fixing the docs in all the other charts? It is a bit chicken and egg story. Not merging this PR will not safeguard other PRs from preventing again outdated docs.

Not updating the docs will fail the builds till they are fixed.

I know there is a policy to only touch one chart per PR. Should we create one PR per chart just fixing the docs to merge this PR straight afterwards, or shall we skip that policy one time by fixing all the docs in this PR?

@cpanato @sabre1041 please let me know how you would like to move this forward.

@marcofranssen marcofranssen force-pushed the check-lock-file branch 2 times, most recently from 90e495f to 80a5e27 Compare January 2, 2023 09:01
Signed-off-by: Marco Franssen <marco.franssen@gmail.com>
Signed-off-by: Marco Franssen <marco.franssen@gmail.com>
Signed-off-by: Marco Franssen <marco.franssen@gmail.com>
@cpanato
Copy link
Member

cpanato commented Jun 27, 2024

@marcofranssen can you rebase and update?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants