geek-cookbook/.github/workflows/mkdocs-build-sanity-check.yml

name: 'mkdocs sanity check'
on: 
  pull_request:
    types: [opened, synchronize]

jobs:
  mkdocs-sanity-check:
    name: Check mkdocs builds successfully
    runs-on: ubuntu-latest
    permissions: write-all
    steps:
    - name: Check out code
      uses: actions/checkout@v2

    - name: Set up Python 3.8
      uses: actions/setup-python@v2
      with:
        python-version: 3.8
        architecture: x64

    - name: Install requirements
      run: python3 -m pip install -r requirements.txt

    - name: Install mkdocs-material
      run: python3 -m pip install mkdocs-material

    - name: Test mkdocs builds
      run: python3 -m mkdocs build

    - name: Link Checker
      id: lychee
      uses: lycheeverse/lychee-action@v1
      with:
        args: --verbose --no-progress site/**/*.html      
      env:
        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
        
    - name: Create Issue From File
      if: steps.lychee.outputs.exit_code != 0
      uses: peter-evans/create-issue-from-file@v4
      with:
        title: Link Checker Report
        content-filepath: ./lychee/out.md
        labels: report, automated issue