ci: add validation with yamllint (#951) #121
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 | |
on: | |
push: | |
branches: | |
- master | |
pull_request: | |
paths: | |
- mkdocs.yml | |
- docs/** | |
- README.md | |
- LICENSE | |
- extras/**/README.md | |
- .github/CONTRIBUTING.md | |
workflow_dispatch: | |
jobs: | |
lint: | |
name: Lint Documentation | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: DavidAnson/markdownlint-cli2-action@v16 | |
with: | |
globs: | | |
docs/**/*.md | |
README.md | |
extras/**/README.md | |
.github/CONTRIBUTING.md | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: "3.12" | |
cache: 'pip' | |
- name: Install dependencies | |
run: | | |
pip install --upgrade pip | |
pip install --requirement docs/requirements.txt | |
- name: Build documentation | |
run: mkdocs build | |
# To remove if not using github pages | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: site |