docs: invoke AbstractAlgebra.doctestsetup() #3056
Workflow file for this run
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: Run tests | |
| on: | |
| push: | |
| branches: | |
| - 'master' | |
| - 'release-' | |
| tags: '*' | |
| pull_request: | |
| schedule: | |
| # Every day at 3:13 AM UTC | |
| - cron: '13 3 * * *' | |
| 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: | |
| test: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| julia-version: | |
| - '1.6' | |
| - '1.10' | |
| - '1.11' | |
| - 'nightly' | |
| os: | |
| - ubuntu-latest | |
| include: | |
| # Add a few windows and macOS jobs (not too many, the number we can run in parallel is limited) | |
| - julia-version: '1.10' | |
| os: macOS-latest | |
| - julia-version: '1.10' | |
| os: windows-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| # For Codecov, we must also fetch the parent of the HEAD commit to | |
| # be able to properly deal with PRs / merges | |
| fetch-depth: 2 | |
| - name: "Set up Julia" | |
| uses: julia-actions/setup-julia@v2 | |
| with: | |
| version: ${{ matrix.julia-version }} | |
| - name: "Cache artifacts" | |
| uses: julia-actions/cache@v2 | |
| - name: "Build package" | |
| uses: julia-actions/julia-buildpkg@v1 | |
| - name: "Run tests" | |
| uses: julia-actions/julia-runtest@v1 | |
| with: | |
| depwarn: error | |
| - name: "Run doctests" | |
| if: ${{ matrix.julia-version == '1.10' }} | |
| run: | | |
| julia --project=docs --color=yes --code-coverage -e ' | |
| using Pkg | |
| Pkg.develop(PackageSpec(path=pwd())) | |
| Pkg.instantiate() | |
| using Documenter | |
| import Nemo: Nemo, AbstractAlgebra | |
| DocMeta.setdocmeta!(Nemo, :DocTestSetup, :(using Nemo); recursive = true) | |
| DocMeta.setdocmeta!(AbstractAlgebra, :DocTestSetup, AbstractAlgebra.doctestsetup(); recursive = true) | |
| doctest(Nemo)' | |
| - name: "Process code coverage" | |
| uses: julia-actions/julia-processcoverage@v1 | |
| - name: "Upload coverage data to Codecov" | |
| continue-on-error: true | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| docs: | |
| name: Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: julia-actions/setup-julia@v2 | |
| with: | |
| version: '1.10' | |
| - uses: julia-actions/cache@v2 | |
| - uses: julia-actions/julia-buildpkg@v1 | |
| - uses: julia-actions/julia-docdeploy@v1 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} |