Docs: update #565
Workflow file for this run
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
| # Requires GitHub Pages publishing branch to be `gh-pages` | |
| name: GitHub Pages | |
| on: | |
| pull_request: | |
| types: | |
| # - edited # PR's base branch was changed | |
| - opened | |
| - reopened | |
| - synchronize # PR's branch was edited (i.e. new commits) | |
| release: | |
| types: | |
| - published | |
| jobs: | |
| markdown-lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - run: docker run -v $PWD:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest --disable MD013 MD033 MD046 -- "**/*.md" | |
| mkdocs-build: | |
| if: github.event_name == 'pull_request' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.x | |
| - uses: actions/cache@v3 | |
| with: | |
| key: ${{ github.ref }} | |
| path: .cache | |
| - run: pip install mkdocs-material | |
| - run: pip install mkdocs-git-revision-date-localized-plugin mkdocs-redirects mkdocs-htmlproofer-plugin mdx_truly_sane_lists | |
| - run: | | |
| pip install pillow cairosvg | |
| sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev | |
| - run: mkdocs build --strict --verbose | |
| # !!! This check should be required by GitHub !!! | |
| pages-status-check: | |
| if: always() | |
| needs: | |
| - markdown-lint | |
| - mkdocs-build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} | |
| deploy: | |
| if: github.event_name == 'release' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.x | |
| - uses: actions/cache@v3 | |
| with: | |
| key: ${{ github.ref }} | |
| path: .cache | |
| - run: pip install mkdocs-material | |
| - run: pip install mkdocs-git-revision-date-localized-plugin mkdocs-redirects mkdocs-htmlproofer-plugin mdx_truly_sane_lists | |
| - run: | | |
| pip install pillow cairosvg | |
| sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev | |
| - run: mkdocs gh-deploy --strict --verbose --force |