Feature: v3.0.0 #1725
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 | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| path-filter: | |
| permissions: | |
| pull-requests: read | |
| runs-on: ubuntu-latest | |
| outputs: | |
| changes: ${{ steps.filter.outputs.changes }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - id: filter | |
| uses: dorny/paths-filter@v2 | |
| with: | |
| filters: | | |
| changes: | |
| - 'docs/**' | |
| - '**/*.md' | |
| - 'mkdocs.yml' | |
| lint: | |
| needs: | |
| - path-filter | |
| if: ${{ needs.path-filter.outputs.changes == 'true' }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: docker run --rm --volume "${PWD}:/workdir" ghcr.io/igorshubovych/markdownlint-cli:latest --disable MD013 MD033 MD041 MD046 -- "**/*.md" | |
| build: | |
| needs: | |
| - path-filter | |
| if: ${{ github.event_name == 'pull_request' && needs.path-filter.outputs.changes == 'true' }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| # the `git-revision-date-localized` plugin needs full history to find page creation date | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.x | |
| - uses: actions/cache@v4 | |
| with: | |
| key: ${{ github.ref }} | |
| path: .cache | |
| - run: | | |
| pip install --requirement docs/requirements.txt | |
| 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: | |
| - path-filter | |
| - lint | |
| - build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: re-actors/alls-green@release/v1 | |
| with: | |
| allowed-skips: lint, build | |
| jobs: ${{ toJSON(needs) }} | |
| deploy: | |
| if: github.event_name == 'release' | |
| permissions: | |
| contents: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| # the `git-revision-date-localized` plugin needs full history to find page creation date | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.x | |
| - uses: actions/cache@v4 | |
| with: | |
| key: ${{ github.ref }} | |
| path: .cache | |
| - run: | | |
| pip install --requirement docs/requirements.txt | |
| sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev | |
| - run: mkdocs gh-deploy --strict --verbose --force |