Checks

How to piece together general-purpose actions to handle checks of MkDocs.

Sample

Based on another project I found.

This won’t persist the docs.

• main.yml

    name: Check docs
  
    on:
      pull_request:
      push:
        branches:
          - master
  
    jobs:
      link-checker:
        runs-on: ubuntu-latest
  
        steps:
          - uses: actions/checkout@v2
  
          - name: Set up Python 3.x
            uses: actions/setup-python@v2
  
          - name: Install dependencies
            run: |
              python -m pip install --upgrade pip
              pip install -r docs/requirements.txt
  
          - name: Build docs
            run: mkdocs build
  
          - name: Link Checker
            id: lc
            uses: peter-evans/link-checker@v1
            with:
              args: -d ./site -r ./site -x man7.org
  
          - name: Fail on errors
            run: exit $
  

Need to research Liche to see appropriate replacement args for the above.

Also mkdocs build --strict is probably a good idea.

You’ll only want to run that on a master build while the link checks above are set up to work on a PR too.