Skip to content

Commit

Permalink
Add helm-docs generation and linting
Browse files Browse the repository at this point in the history
Autogenerate docs for each PR and verify they are up-to-date.

Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
  • Loading branch information
dfarrell07 committed Jun 25, 2021
1 parent 97782b4 commit dc4ffb6
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,24 @@ jobs:
- name: Run gitlint
run: make gitlint

helm-docs:
name: Helm Docs Generation
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v2

- name: Run helm-docs
run: |
HELM_DOCS_VERSION="0.15.0"
# Avoid polluting repo with helm-docs' README/LICENSE or other files in the release archive
cd /tmp
curl -sL "https://github.com/norwoodj/helm-docs/releases/download/v${HELM_DOCS_VERSION}/helm-docs_${HELM_DOCS_VERSION}_Linux_x86_64.tar.gz" | tar zx
cd -
/tmp/helm-docs
git status --porcelain
[[ -z "$(git status --porcelain)" ]]
markdown-link-check:
name: Markdown Links (modified files)
runs-on: ubuntu-latest
Expand Down

0 comments on commit dc4ffb6

Please sign in to comment.