terraform-provider-docker/.github/workflows/website-lint.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

49 lines
1.5 KiB
YAML

---
name: Docs and Website Lint
on:
push:
branches:
- master
- "release/**"
pull_request:
types: ['opened', 'synchronize']
paths:
- .github/workflows/website-lint.yaml
- website/docs/**
env:
GO_VERSION: "1.15"
GOPROXY: https://gocenter.io,https://proxy.golang.org,direct
jobs:
website-lint-spellcheck-tffmt:
runs-on: ubuntu-20.04
strategy:
fail-fast: true
steps:
- uses: actions/checkout@v2
- uses: actions/setup-go@v2
with:
go-version: '1.15'
- run: cat /etc/issue
- run: bash scripts/gogetcookie.sh
# locally: docker run -it ubuntu-20.04 bash (https://ubuntu.pkgs.org/20.04/docker-ce-stable-amd64/)
- run: sudo apt-get update
- run: sudo apt-get -y install apt-transport-https ca-certificates curl gnupg-agent software-properties-common
- run: curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
- run: sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
- run: sudo apt-get update
# list available docker versions: apt-cache policy docker-ce
- run: sudo apt-get -y install docker-ce=5:20.10.1~3-0~ubuntu-focal
- run: docker version
- run: make setup
- run: make website-lint
markdown-lint:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: avto-dev/markdown-lint@v1
with:
args: 'website/docs'
config: '.markdownlint.yml'