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

test: add pre-commit hook for helm-docs #26

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

morremeyer
Copy link
Contributor

With this change, users of pre-commit can register a pre-commit hook that automatically
runs helm-docs when a chart changes.

This saves contributors such as me from forgetting to run helm-docs every single time
they commit if they want to do so.

With this change, users of pre-commit can register a pre-commit hook that automatically
runs helm-docs when a chart changes.

This saves contributors such as me from forgetting to run `helm-docs` every single time
they commit if they want to do so.
@rlex
Copy link
Collaborator

rlex commented Nov 20, 2022

I thought about implementing helm-docs as a part of CI pipeline, but maybe having both options is good idea

@morremeyer
Copy link
Contributor Author

We could add pre-commit lite action (https://pre-commit.ci/lite.html), this would run pre-commit and commit the fixes.

That way, if any other linters or doc generators are added later, they are automatically run, too.

What do you think?

@rlex
Copy link
Collaborator

rlex commented Nov 20, 2022

I never commited anything from CI, wonder how it will appear in commit history? From github internal user?

@morremeyer
Copy link
Contributor Author

Depends on the user creating the commit.

If you check morremeyer/charts, you'll see commits from a bot user (not an app!) that we use in that repo.

With pre-commit lite, it will appear as the app user. In that case pre-commit-ci-lite (bot).

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