docs-ci #31
This file contains hidden or 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: docs-ci | |
| on: | |
| pull_request: | |
| paths: | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - "scripts/docs_linkcheck.py" | |
| - "scripts/docs_external_linkcheck.py" | |
| - ".codespell_dictionary.txt" | |
| - ".codespellrc.ini" | |
| - ".github/workflows/docs-ci.yml" | |
| push: | |
| branches: [master] | |
| paths: | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - "scripts/docs_linkcheck.py" | |
| - "scripts/docs_external_linkcheck.py" | |
| - ".codespell_dictionary.txt" | |
| - ".codespellrc.ini" | |
| - ".github/workflows/docs-ci.yml" | |
| schedule: | |
| - cron: "0 6 * * 1" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| - name: Install deps | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install mkdocs mkdocs-swagger-ui-tag mkdocs-material pymdown-extensions codespell \ | |
| mkdocs-git-revision-date-localized-plugin mkdocs-git-authors-plugin \ | |
| mkdocs-redirects mkdocs-minify-plugin mkdocs-glightbox \ | |
| pillow cairosvg | |
| - name: Markdown lint | |
| run: make mdlint | |
| - name: Spell check (codespell) | |
| run: make codespell | |
| - name: Internal link check | |
| run: python3 scripts/docs_linkcheck.py | |
| - name: External link check | |
| run: python3 scripts/docs_external_linkcheck.py | |
| - name: MkDocs strict build | |
| run: mkdocs build --strict --site-dir .site |