Merge pull request norwoodj#49 from sc250024/fix-PreCommitHookReadmeT…

…emplate fix: Updating hook config for README.md.gotmpl
arcilli · Aug 6, 2020 · 3cfab7a · 3cfab7a
2 parents 2ddaac8 + f67f99d
commit 3cfab7a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -2,7 +2,7 @@
   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
-  files: (Chart|requirements|values)\.yaml$
+  files: (README\.md\.gotmpl|(Chart|requirements|values)\.yaml)$
   language: script
   name: Helm Docs
   require_serial: true
diff --git a/README.md b/README.md
@@ -270,5 +270,4 @@ pre-commit install
 pre-commit install-hooks
 ```
 
-Future changes to your charts requirements.yaml, values.yaml, or Chart.yaml files will cause an update to documentation when
-you commit.
+Future changes to your chart's `requirements.yaml`, `values.yaml`, `Chart.yaml`, or `README.md.gotmpl` files will cause an update to documentation when you commit.