Collect citations from docstrings #152
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: CI | |
on: | |
- push | |
- pull_request | |
concurrency: | |
# Skip intermediate builds: always. | |
# Cancel intermediate builds: only if it is a pull request build. | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }} | |
jobs: | |
test: | |
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }} | |
runs-on: ${{ matrix.os }} | |
strategy: | |
fail-fast: false | |
matrix: | |
os: | |
- ubuntu-latest | |
version: | |
- '1.6' | |
- '1' | |
include: | |
- os: macOS-latest | |
version: '1' | |
- os: windows-latest | |
version: '1' | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: julia-actions/setup-julia@v1 | |
with: | |
version: ${{ matrix.version }} | |
- uses: julia-actions/cache@v1 | |
- name: "Instantiate test environment" | |
run: julia --project=test devrepl.jl | |
- name: "Run tests" | |
run: julia --project=test -L devrepl.jl -e 'test()' | |
- uses: julia-actions/julia-processcoverage@v1 | |
- name: "Summarize coverage" | |
run: julia --project=test -L devrepl.jl -e 'show_coverage()' | |
- uses: codecov/codecov-action@v3 | |
with: | |
files: lcov.info | |
docs: | |
name: Documentation | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
statuses: write | |
pages: write | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: julia-actions/setup-julia@v1 | |
with: | |
version: '1' | |
- name: "Instantiate test environment" | |
run: julia --project=test devrepl.jl | |
- name: "Build documentation" | |
run: julia --project=test docs/make.jl | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} | |
JULIA_DEBUG: Documenter,DocumenterCitations | |
- uses: actions/upload-artifact@v3 | |
with: | |
name: documenter-citations-docs | |
path: docs/build/ | |
codestyle: | |
name: Codestyle | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: julia-actions/setup-julia@v1 | |
with: | |
version: '1' | |
- name: Install JuliaFormatter and format | |
# This will use the latest version by default but you can set the version like so: | |
# | |
# julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))' | |
run: | | |
julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))' | |
julia -e 'using JuliaFormatter; format(["src", "docs", "test", "devrepl.jl"], verbose=true)' | |
- name: Format check | |
run: | | |
julia -e ' | |
out = Cmd(`git diff --name-only`) |> read |> String | |
if out == "" | |
exit(0) | |
else | |
@error "Some files have not been formatted !!!" | |
write(stdout, out) | |
exit(1) | |
end' |