meilisearch / meilisearch-kubernetes

Meilisearch on Kubernetes Helm charts and manifests
https://www.meilisearch.com
MIT License
217 stars 59 forks source link

Run helm-docs on new PRs #198

Open AndersBennedsgaard opened 1 year ago

AndersBennedsgaard commented 1 year ago

Description The Helm chart documentation gets out of sync on each release (https://github.com/meilisearch/meilisearch-kubernetes/blob/main/charts/meilisearch/README.md reports latest version as 0.2.1 even though it should be 0.2.5), since helm-docs isn't a part of the Github workflows. I propose that we run helm-docs on merging with main or checking that contributors has run the command before it can be merged into main.

Basic example A simple step which verifies that a contributor has run helm-docs:

      - name: Render documentation
        run: |
          export PATH=$PATH:$(go env GOPATH)/bin
          helm-docs
          git update-index -q --ignore-submodules --refresh
          if ! git diff-files --quiet --ignore-submodules -- ; then
            echo Generating documentation caused a change - did you forget to run 'helm-docs' before commit?
            exit 1
          fi
brunoocasali commented 1 year ago

Yes I agree with that @AndersBennedsgaard!

Can you send a PR to fix the issue?!