Misc docs improvements #305
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: Build docs and check cloudformation and dead links | |
on: | |
pull_request: | |
branches: | |
- main | |
jobs: | |
check: | |
name: build docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v3.0.0 | |
- name: Install dependencies | |
run: | | |
pip install -r requirements.txt | |
- name: Build documentation | |
run: | | |
mkdocs build | |
- name: Setup cloudformation linter | |
uses: ScottBrenner/cfn-lint-action@v2.2.1 | |
- name: Run cloudformation lint | |
run: cfn-lint -t stack.yml | |
- name: Check dead links | |
uses: gaurav-nelson/github-action-markdown-link-check@v1 | |
with: | |
folder-path: '.' | |
config-file: 'markdown-link-check-config.yml' | |
use-verbose-mode: 'yes' | |
use-quiet-mode: 'yes' |