CI: check for jldoctest end markers and unknown admonitions #5
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: docstring test | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - 'release-*' | |
| pull_request: | |
| workflow_dispatch: | |
| concurrency: | |
| # group by workflow and ref; the last slightly strange component ensures that for pull | |
| # requests, we limit to 1 concurrent job, but for the master branch we don't | |
| group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref != 'refs/heads/master' || github.run_number }} | |
| # Cancel intermediate builds, but only if it is a pull request build. | |
| cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }} | |
| jobs: | |
| check-docstrings: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: julia-actions/setup-julia@v2 | |
| - uses: julia-actions/cache@v2 | |
| - name: Build package | |
| uses: julia-actions/julia-buildpkg@v1 | |
| - name: 'Check issues in docstrings' | |
| run: | | |
| julia --project=. -e 'using Oscar; include("etc/check_docstrings.jl")' |