Documentation Checks #4842
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation Checks | |
| on: | |
| push: | |
| branches: | |
| - master | |
| merge_group: | |
| pull_request: | |
| paths: | |
| - .markdownlinkcheck.json | |
| - .markdownlint.yml | |
| - .github/workflows/documentation.yml | |
| - docs/** | |
| env: | |
| GO_VERSION: "1.22" | |
| GO111MODULE: on | |
| jobs: | |
| markdown-link-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: gaurav-nelson/github-action-markdown-link-check@1.0.15 | |
| with: | |
| use-quiet-mode: 'yes' | |
| use-verbose-mode: 'yes' | |
| config-file: '.markdownlinkcheck.json' | |
| folder-path: 'docs' | |
| file-extension: '.md' | |
| markdown-lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: avto-dev/markdown-lint@v1.5.0 | |
| with: | |
| config: '.markdownlint.yml' | |
| args: 'docs' | |
| misspell: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Checkout should always be before setup-go to ensure caching is working | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - uses: actions/cache@v4 | |
| continue-on-error: true | |
| timeout-minutes: 2 | |
| with: | |
| path: ~/go/pkg/mod | |
| key: ${{ runner.os }}-go-pkg-mod-${{ hashFiles('go.sum') }} | |
| - run: go install github.com/client9/misspell/cmd/misspell@latest | |
| - run: misspell -error -source text docs/ |