diff --git a/.gitignore b/.gitignore index 3ce3033..5b6b0c6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ -helm-docs +/helm-docs +/cmd/helm-docs/helm-docs dist diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..d94b51a --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,5 @@ +repos: + - repo: https://github.com/norwoodj/helm-docs + rev: v0.7.0 + hooks: + - id: helm-docs diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml index 4ada7f9..7d83427 100644 --- a/.pre-commit-hooks.yaml +++ b/.pre-commit-hooks.yaml @@ -1,8 +1,8 @@ -- id: helm_docs +- id: helm-docs args: [] description: Uses 'helm-docs' to create documentation from the Helm chart's 'values.yaml' file, and inserts the result into a corresponding 'README.md' file. - entry: git-hook/helm_docs.sh + entry: git-hook/helm-docs files: (Chart|requirements|values)\.yaml$ language: script - name: Helm docs + name: Helm Docs require_serial: true diff --git a/git-hook/helm_docs.sh b/git-hook/helm-docs similarity index 100% rename from git-hook/helm_docs.sh rename to git-hook/helm-docs