Apply GitHub workflow changes #902
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: | |
| - main | |
| pull_request: | |
| paths: | |
| - .ci/.markdownlinkcheck.json | |
| - .markdownlint.yml | |
| - .github/workflows/documentation.yml | |
| - docs/** | |
| - go.mod | |
| ## NOTE: !!! | |
| ## When changing these workflows, ensure that the following is updated: | |
| ## - Documentation: docs/continuous-integration.md | |
| ## - Documentation: docs/makefile-cheat-sheet.md | |
| ## - Makefile: ./GNUmakefile | |
| jobs: | |
| markdown-link-check: | |
| runs-on: ubuntu-latest | |
| env: | |
| UV_THREADPOOL_SIZE: 128 | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - uses: YakDriver/md-check-links@0a295ce2e08c544aae01cccc9b4c6801a8398942 # v2.2.0 | |
| with: | |
| quiet: 'yes' | |
| verbose: 'yes' | |
| config: '.ci/.markdownlinkcheck.json' | |
| directory: 'docs' | |
| extension: '.md' | |
| branch: "main" | |
| modified: "yes" | |
| markdown-lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb # v1.5.0 | |
| with: | |
| args: 'docs' | |
| misspell: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0 | |
| with: | |
| go-version-file: go.mod | |
| - uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2 | |
| continue-on-error: true | |
| timeout-minutes: 2 | |
| with: | |
| path: ~/go/pkg/mod | |
| key: ${{ runner.os }}-go-pkg-mod-${{ hashFiles('go.sum') }} | |
| - run: cd .ci/tools && go install github.com/client9/misspell/cmd/misspell | |
| - run: make docs-misspell |