Skip to content

Docsuite revamp

Docsuite revamp #14418

Workflow file for this run

name: Documentation
on:
pull_request:
push:
branches:
- main
tags: '*'
# Documenter deploys with `git push --force-with-lease`, which fails when another run has
# moved `gh-pages` since this one cloned it. Superseding an in-progress run keeps two
# deployments of the same ref from racing each other.
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
docbuild:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v7
- uses: julia-actions/setup-julia@v3
with:
version: '1.10'
- name: Install dependencies
run: >
julia --project=docs -e 'using Pkg;
Pkg.develop([
PackageSpec(path="lib/ClimaCoreTempestRemap"),
PackageSpec(path="lib/ClimaCoreSpectra"),
PackageSpec(path="."),
]);
Pkg.instantiate(;verbose=true)'
- name: Build and deploy
env:
GKSwstype: "100" # headless GR: https://discourse.julialang.org/t/generation-of-documentation-fails-qt-qpa-xcb-could-not-connect-to-display/60988/2
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
run: julia --project=docs/ docs/make.jl