Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run helm-docs on new PRs #198

Open
AndersBennedsgaard opened this issue Sep 18, 2023 · 1 comment
Open

Run helm-docs on new PRs #198

AndersBennedsgaard opened this issue Sep 18, 2023 · 1 comment

Comments

@AndersBennedsgaard
Copy link

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
Copy link
Member

Yes I agree with that @AndersBennedsgaard!

Can you send a PR to fix the issue?!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants