Skip to content

Merge pull request #1720 from hashicorp/dependabot/go_modules/aws-sdk… #1097

Merge pull request #1720 from hashicorp/dependabot/go_modules/aws-sdk…

Merge pull request #1720 from hashicorp/dependabot/go_modules/aws-sdk… #1097

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@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- 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@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb # v1.5.0
with:
config: ".markdownlint.yml"
args: "contributing"
misspell:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1
with:
go-version-file: tools/go.mod
- uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
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/