Skip to content

Add information on how to cite OSCAR to doc #14206

Add information on how to cite OSCAR to doc

Add information on how to cite OSCAR to doc #14206

Workflow file for this run

name: Run tests
on:
push:
branches:
- master
- 'release-*'
pull_request:
workflow_dispatch:
# needed to allow julia-actions/cache to delete old caches that it has created
permissions:
actions: write
contents: read
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 }}
timeout-minutes: 150
strategy:
fail-fast: false
matrix:
julia-version:
- '1.6'
- '1.10'
- '1.11-nightly'
- 'nightly'
group: [ 'short', 'long' ]
os:
- ubuntu-latest
depwarn: [ '' ]
include:
# Add a single job per group with deprecation errors on the most recent stable julia version
- julia-version: '1.10'
group: 'short'
os: ubuntu-latest
depwarn: 'depwarn=error'
- julia-version: '1.10'
group: 'long'
os: ubuntu-latest
depwarn: 'depwarn=error'
# Add a few macOS jobs (not too many, the number we can run in parallel is limited)
- julia-version: '1.10'
group: 'short'
os: macOS-14
- julia-version: '1.10'
group: 'long'
os: macOS-latest
# nightly on macos is disabled for now since the macos jobs take too long
# with just 5 runners
#- julia-version: 'nightly'
# group: 'short'
# os: macOS-latest
#- julia-version: 'nightly'
# group: 'long'
# os: macOS-latest
steps:
- uses: actions/checkout@v3
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@v1
with:
version: ${{ matrix.julia-version }}
- uses: julia-actions/cache@v1
with:
cache-name: julia-cache;workflow=${{ github.workflow }};julia=${{ matrix.julia-version }};arch=${{ runner.arch }}
include-matrix: false
- name: "Build package"
uses: julia-actions/julia-buildpkg@v1
- name: "limit OpenMP threads"
if: runner.os == 'macOS'
# restrict number of openMP threads on macOS due to oversubscription
run: echo "OMP_NUM_THREADS=1" >> $GITHUB_ENV
- name: "set test subgroup"
if: ${{ matrix.group }} != ''
run: echo "OSCAR_TEST_SUBSET=${{matrix.group}}" >> $GITHUB_ENV
- name: "Run tests"
uses: julia-actions/julia-runtest@latest
with:
annotate: ${{ matrix.julia-version == '1.10' }}
coverage: ${{ matrix.julia-version == '1.10' }}
depwarn: ${{ matrix.depwarn == 'depwarn=error' && 'error' || 'no' }}
- name: "Process code coverage"
if: matrix.julia-version == '1.10' && matrix.depwarn != 'depwarn=error'
uses: julia-actions/julia-processcoverage@v1
with:
directories: src,experimental
- name: "Upload coverage data to Codecov"
if: matrix.julia-version == '1.10' && matrix.depwarn != 'depwarn=error'
continue-on-error: true
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
doctest:
runs-on: ${{ matrix.os }}
timeout-minutes: 150
strategy:
fail-fast: false
matrix:
julia-version:
- '1.10'
- '1.11-nightly'
- 'nightly'
os:
- ubuntu-latest
depwarn: [ '' ]
include:
# Add a single job with deprecation errors on the most recent stable julia version
- julia-version: '1.10'
os: ubuntu-latest
depwarn: 'depwarn=error'
# Add macOS jobs (not too many, the number we can run in parallel is limited)
- julia-version: '1.10'
os: macOS-14
steps:
- uses: actions/checkout@v3
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@v1
with:
version: ${{ matrix.julia-version }}
- uses: julia-actions/cache@v1
with:
cache-name: julia-cache;workflow=${{ github.workflow }};julia=${{ matrix.julia-version }};arch=${{ runner.arch }}
include-matrix: false
- name: "Build package"
uses: julia-actions/julia-buildpkg@v1
- name: "limit OpenMP threads"
if: runner.os == 'macOS'
# restrict number of openMP threads on macOS due to oversubscription
run: echo "OMP_NUM_THREADS=1" >> $GITHUB_ENV
- name: "Setup package"
run: |
julia --project=docs --color=yes -e '
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()'
- name: "Run doctests"
run: |
julia ${{ matrix.julia-version == '1.10' && '--code-coverage' || '' }} \
--project=docs --depwarn=${{ matrix.depwarn == 'depwarn=error' && 'error' || 'no' }} --color=yes -e'
using Documenter
include("docs/documenter_helpers.jl")
using Oscar
DocMeta.setdocmeta!(Oscar, :DocTestSetup, Oscar.doctestsetup(); recursive = true)
doctest(Oscar)'
- name: "Process code coverage"
if: matrix.julia-version == '1.10' && matrix.depwarn != 'depwarn=error'
uses: julia-actions/julia-processcoverage@v1
with:
directories: src,experimental
- name: "Upload coverage data to Codecov"
if: matrix.julia-version == '1.10' && matrix.depwarn != 'depwarn=error'
continue-on-error: true
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}