Merge pull request #2135 from hashicorp/f-2024-12-13-schema-updates #1418
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 Linters | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - "release/**" | |
| pull_request: | |
| paths: | |
| - .github/workflows/documentation-linters.yml | |
| - .github/**/*.md | |
| - .markdownlint.yml | |
| - contributing/** | |
| - tools/go.mod | |
| # - website/** | |
| jobs: | |
| markdown-link-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - uses: gaurav-nelson/github-action-markdown-link-check@d53a906aa6b22b8979d33bc86170567e619495ec # 1.0.15 | |
| with: | |
| use-quiet-mode: "yes" | |
| use-verbose-mode: "yes" | |
| config-file: ".markdownlinkcheck.json" | |
| folder-path: "contributing,.github" | |
| file-extension: ".md" | |
| markdown-lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb # v1.5.0 | |
| with: | |
| config: ".markdownlint.yml" | |
| args: "contributing" | |
| misspell: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0 | |
| with: | |
| go-version-file: tools/go.mod | |
| - uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0 | |
| continue-on-error: true | |
| id: cache-go-pkg-mod | |
| timeout-minutes: 2 | |
| with: | |
| path: ~/go/pkg/mod | |
| key: ${{ runner.os }}-go-pkg-mod-${{ hashFiles('go.sum') }} | |
| - run: cd tools && go install github.com/client9/misspell/cmd/misspell | |
| - run: misspell -error -source text -locale US contributing/ .github/ |