Skip to content

Prep for v0.16.3 (#705) #928

Prep for v0.16.3 (#705)

Prep for v0.16.3 (#705) #928

Workflow file for this run

name: Documentation
on:
push:
branches: [master]
tags: '*'
paths:
- '.github/workflows/docs.yml'
- 'src/**'
- 'docs/**'
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
paths:
- '.github/workflows/docs.yml'
- 'src/**'
- 'docs/**'
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:
build:
# Run on push's or non-draft PRs
if: (github.event_name == 'push') || (github.event.pull_request.draft == false) || (github.event_name == 'workflow_dispatch')
runs-on: ubuntu-latest
env:
GKSwstype: nul
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@latest
with:
# Build documentation on Julia v1.10
version: '1.10'
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
run: julia --color=yes --project=docs/ docs/make.jl
- uses: errata-ai/vale-action@reviewdog
with:
version: 3.0.5
files: docs/src
fail_on_error: true
filter_mode: nofilter
vale_flags: "--config=.vale.ini"
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}