Move docs script to root of repo

This makes it easier for contributors to ensure docs are updated by having the script more easy at hand. Signed-off-by: Marco Franssen <[email protected]>
2023-02-14 14:04:31 +01:00
parent fe5b3a2a16
commit c3ac45eec8
3 changed files with 3 additions and 3 deletions
@@ -6,7 +6,7 @@ on:
    paths:
      - 'charts/**'
      - '.github/workflows/helm-chart-ci.yml'
-      - '.github/scripts/*.sh'
+      - 'helm-docs.sh'
      - '.github/kind/conf/kind-config.yaml'

 concurrency:
@@ -27,7 +27,7 @@ jobs:
        uses: actions/[email protected]

      - name: Verify Docs updated
-        run: .github/scripts/helm-docs.sh
+        run: ./helm-docs.sh

  lint-chart:
    runs-on: ubuntu-22.04
@@ -39,7 +39,7 @@ git rebase main
 Any changes to Chart.yaml or values.yaml require an update of the README.md. This update can easily be generated using [helm-docs][].

 ```shell
-helm-docs -g charts/«chart-name» -t .github/README.md.tmpl
+./helm-docs.sh charts/«chart-name»
 ```

 [helm-docs]: https://github.com/norwoodj/helm-docs "Generate documentation for your Helm chart."