Documenter semver guarantee docs #1550
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: | |
branches: | |
- master | |
- release-* | |
- runci/* | |
tags: '*' | |
pull_request: | |
jobs: | |
test: | |
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} | |
runs-on: ${{ matrix.os }} | |
strategy: | |
fail-fast: false | |
matrix: | |
version: | |
- '1.6' | |
- '1' | |
- 'nightly' | |
os: | |
- ubuntu-latest | |
- macos-latest | |
- windows-latest | |
arch: | |
- x64 | |
include: | |
- os: ubuntu-latest | |
version: '1' | |
arch: x86 | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: julia-actions/setup-julia@v1 | |
with: | |
version: ${{ matrix.version }} | |
arch: ${{ matrix.arch }} | |
show-versioninfo: true | |
- uses: julia-actions/cache@v1 | |
- uses: julia-actions/julia-buildpkg@v1 | |
- uses: julia-actions/julia-runtest@v1 | |
- uses: julia-actions/julia-processcoverage@v1 | |
- uses: codecov/codecov-action@v3 | |
with: | |
file: lcov.info | |
- name: Submit coverage to Coveralls | |
uses: coverallsapp/github-action@v2 | |
with: | |
github-token: ${{ secrets.GITHUB_TOKEN }} | |
path-to-lcov: lcov.info | |
latex: | |
name: "PDF/LaTeX backend" | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: julia-actions/setup-julia@v1 | |
with: | |
version: '1' | |
- uses: julia-actions/cache@v1 | |
- run: | | |
julia --project=test/examples -e ' | |
using Pkg | |
Pkg.instantiate() | |
Pkg.develop(PackageSpec(path=pwd())) | |
Pkg.add(["IOCapture", "tectonic_jll"])' | |
- run: julia --project=test/examples --code-coverage test/examples/tests_latex.jl | |
- uses: julia-actions/julia-processcoverage@v1 | |
- uses: codecov/codecov-action@v3 | |
with: | |
file: lcov.info | |
- name: Submit coverage to Coveralls | |
uses: coverallsapp/github-action@v2 | |
with: | |
github-token: ${{ secrets.GITHUB_TOKEN }} | |
path-to-lcov: lcov.info | |
- uses: actions/upload-artifact@v3 | |
with: | |
name: PDFs | |
path: test/examples/builds/*/*.pdf | |
themes: | |
name: "CSS for HTML themes" | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: julia-actions/setup-julia@v1 | |
with: | |
version: '1' | |
- uses: julia-actions/cache@v1 | |
- name: Install dependencies | |
run: julia --color=yes --project=test/themes/ docs/instantiate.jl test/themes/ | |
- name: Verify theme CSS files | |
run: julia --color=yes --project=test/themes test/themes/themes.jl | |
prerender: | |
name: "NodeJS for prerender" | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: julia-actions/setup-julia@v1 | |
with: | |
version: '1' | |
- uses: julia-actions/cache@v1 | |
- run: | | |
julia --project=test/prerender/ -e ' | |
using Pkg | |
Pkg.instantiate() | |
Pkg.develop(PackageSpec(path=pwd()))' | |
- run: julia --color=yes --project=test/prerender --code-coverage test/prerender/prerender.jl | |
- uses: julia-actions/julia-processcoverage@v1 | |
- uses: codecov/codecov-action@v3 | |
with: | |
file: lcov.info | |
- name: Submit coverage to Coveralls | |
uses: coverallsapp/github-action@v2 | |
with: | |
github-token: ${{ secrets.GITHUB_TOKEN }} | |
path-to-lcov: lcov.info | |
docs: | |
name: 'Documentation: ${{ matrix.format }}' | |
runs-on: ubuntu-latest | |
strategy: | |
fail-fast: false | |
matrix: | |
format: | |
- html | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: julia-actions/setup-julia@v1 | |
with: | |
version: '1' | |
- uses: julia-actions/cache@v1 | |
- name: Install dependencies | |
run: julia --color=yes --project=docs/ docs/instantiate.jl | |
- name: Build the manual | |
run: julia --color=yes --project=docs/ docs/make.jl ${{ matrix.format }} | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} | |
DOCUMENTER_LATEX_DEBUG: ${{ github.workspace }}/latex-debug-logs | |
- uses: actions/upload-artifact@v3 | |
if: ${{ always() && matrix.format == 'pdf' }} | |
with: | |
name: PDF build logs | |
path: ${{ github.workspace }}/latex-debug-logs | |
linkcheck: | |
name: "Linkcheck: online tests" | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: julia-actions/setup-julia@latest | |
with: | |
version: '1.6' | |
- name: Run online linkcheck tests | |
run: julia --color=yes test/run_docchecks.jl | |
linkcheck-manual: | |
name: "Linkcheck: Documenter manual" | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: julia-actions/setup-julia@latest | |
with: | |
version: '1.6' | |
- name: Install dependencies | |
run: julia --color=yes --project=docs/ docs/instantiate.jl | |
- name: Build and check documentation | |
run: julia --color=yes --project=docs/ docs/make.jl linkcheck |