lint.yaml

name: lint

on:
  push:
    branches:
      - "main"
  pull_request:
    branches:
      - "main"
  schedule:
    - cron: "0 0 * * *"
  workflow_dispatch:

jobs:
  check:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Install Conda environment
        uses: mamba-org/setup-micromamba@v1
        with:
          environment-file: devtools/conda-envs/lint_env.yml
          # default - will pull down 2.0 which we don't want!
          # micromamba-version: latest
          # pin to latest 1.x release
          micromamba-version: "1.5.10-0"

      - name: Check dead links
        shell: bash -l {0}
        run: |
          FORCE_COLOR=1 sphinx-build -n -W --keep-going -b linkcheck source build/linkcheck

      - name: Check code blocks
        shell: bash -l {0}
        run: |
          FORCE_COLOR=1 sphinx-build -n -W --keep-going -b codelinter source build/codelinter