linting.yml

name: Linting
on:
  # Note: onlyAnnotateModifiedLines only works correctly on PRs!
  # If you need to run checks on push as well, create a separate workflow file.
  pull_request:

jobs:
  prose:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v2
      with:
        fetch-depth: 0

    - name: Vale
      uses: errata-ai/vale-action@master
      with:
        # We can modify these styles as we want
        styles: |
          https://github.com/errata-ai/Google/releases/latest/download/Google.zip
        onlyAnnotateModifiedLines: true
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v2

    - uses: actions/setup-python@v2
      with:
        python-version: '3.x'
        cache: 'pip'

    - name: Install Python dependencies
      run: pip3 install -r docs/requirements.txt
    
    - name: Build docs
      working-directory: docs
      run: make html

    - name: Check links
      working-directory: docs
      run: make checklinks