helm-charts icon indicating copy to clipboard operation
helm-charts copied to clipboard

Add linting job

Open marcofranssen opened this issue 2 years ago • 2 comments

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 avatar Nov 30 '22 11:11 marcofranssen

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 avatar Jan 02 '23 08:01 marcofranssen

@marcofranssen can you rebase and update?

cpanato avatar Jun 27 '24 09:06 cpanato