Wolfgang Walther
6858693291
Using the -latest tag is potentially prone to errors, because an update of the tag could break our CI. This recently happend with macos-latest, which we downgraded to macos-12 earlier. Using an explicit version reference makes this problem much less likely - in fact renovate will pick up new versions once they exist and will suggest updates for it. Thus, we will see the failures in a related PR instead of randomly everywhere.
68 lines
1.8 KiB
YAML
68 lines
1.8 KiB
YAML
name: Docs
|
|
|
|
on:
|
|
workflow_call:
|
|
secrets:
|
|
CACHIX_AUTH_TOKEN:
|
|
required: false
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
- v[0-9]+
|
|
paths:
|
|
- .github/workflows/docs.yaml
|
|
- .github/actions/setup-nix/**
|
|
- default.nix
|
|
- nix/**
|
|
- docs/**
|
|
- '!**.md'
|
|
|
|
concurrency:
|
|
# Terminate all previous runs of the same workflow for pull requests
|
|
group: docs-${{ github.head_ref || github.run_id }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build:
|
|
name: Build
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
|
- name: Setup Nix Environment
|
|
uses: ./.github/actions/setup-nix
|
|
with:
|
|
authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
|
|
tools: docs.build.bin
|
|
- run: postgrest-docs-build
|
|
- run: git diff --exit-code HEAD locales || echo "Please commit changes to the locales/ folder after running postgrest-docs-build."
|
|
|
|
|
|
spellcheck:
|
|
name: Spellcheck
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
|
- name: Setup Nix Environment
|
|
uses: ./.github/actions/setup-nix
|
|
with:
|
|
authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
|
|
tools: docs.spellcheck.bin docs.dictcheck.bin
|
|
- name: Run spellcheck
|
|
run: postgrest-docs-spellcheck
|
|
- name: Run dictcheck
|
|
run: postgrest-docs-dictcheck
|
|
|
|
|
|
linkcheck:
|
|
name: Linkcheck
|
|
if: github.base_ref == 'main'
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
|
- name: Setup Nix Environment
|
|
uses: ./.github/actions/setup-nix
|
|
with:
|
|
authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
|
|
tools: docs.linkcheck.bin
|
|
- run: postgrest-docs-linkcheck
|