terraform-provider-docker/.github/workflows/website-link.yaml
Manuel Vogel 30f2238e0b
feat: add ability to lint/check of links in documentation locally (#98)
* build: adds local check for website links
* build(make): adds website lint and setup target
* docs: fix spellings and hcl blocks
* fix(make): phony cmd for missing targets
* chore: renames website link check workflow
* fix: missing workflow path
* build(make): adds golangci-lint target and tool
* ci: adds website lint workflow
* docs(contributing): adds linter runs
* chore: improves naming of workflow jobs
* ci: moves website lint job
* chore: switches markdown checker imagee to ghcr.io/tcort/markdown-link-check:stable
2020-12-27 19:02:34 +09:00

28 lines
No EOL
779 B
YAML

## These checks will be superseded by documentation.yml
## when the provider documentation layout is moved to
## the Terraform Registry layout.
name: Website Checks
on:
push:
branches:
- master
- 'release/**'
pull_request:
paths:
- .github/workflows/website-link.yaml
- website/docs/**
- .markdownlint.yml
jobs:
markdown-link-check:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: gaurav-nelson/github-action-markdown-link-check@v1
name: markdown-link-check website/docs/**/*.markdown
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
config-file: '.markdownlinkcheck.json'
folder-path: 'website/docs'
file-extension: '.markdown'