From c3ac45eec824cb3e62118a3d6f640d3c11b2d183 Mon Sep 17 00:00:00 2001 From: Marco Franssen Date: Wed, 8 Feb 2023 17:17:33 +0100 Subject: [PATCH] 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 --- .github/workflows/helm-chart-ci.yaml | 4 ++-- CONTRIBUTING.md | 2 +- .github/scripts/helm-docs.sh => helm-docs.sh | 0 3 files changed, 3 insertions(+), 3 deletions(-) rename .github/scripts/helm-docs.sh => helm-docs.sh (100%) diff --git a/.github/workflows/helm-chart-ci.yaml b/.github/workflows/helm-chart-ci.yaml index 8d76b34..c911999 100644 --- a/.github/workflows/helm-chart-ci.yaml +++ b/.github/workflows/helm-chart-ci.yaml @@ -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/checkout@v3.3.0 - name: Verify Docs updated - run: .github/scripts/helm-docs.sh + run: ./helm-docs.sh lint-chart: runs-on: ubuntu-22.04 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e3aaba2..60f5fa2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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." diff --git a/.github/scripts/helm-docs.sh b/helm-docs.sh similarity index 100% rename from .github/scripts/helm-docs.sh rename to helm-docs.sh