doctests.yml

name: doctests
on:
  push:
    branches:
      - 'main'
      - /^release-.*$/
    tags: '*'
  pull_request:
jobs:
  doctests:
    name: Doctests (Julia ${{ matrix.julia-version }} - ${{ github.event_name }})
    runs-on: ubuntu-latest
    strategy:
      matrix:
        julia-version: [1.6.1]
    steps:
      - uses: julia-actions/setup-julia@latest
        with:
          version: ${{ matrix.julia-version }}
      - uses: actions/checkout@v1
      - name: Install dependencies
        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
      - name: Fix doctests
        run: julia --code-coverage --project=docs 'docs/fix_doctests.jl'
      - uses: julia-actions/julia-processcoverage@v1
      - uses: codecov/codecov-action@v1
        with:
          file: lcov.info
      - uses: reviewdog/action-suggester@v1
        if: github.event_name == 'pull_request'
        with:
          tool_name: Documenter (doctests)
          fail_on_error: true