17 Commits

Author SHA1 Message Date
e02883dae0 fix
All checks were successful
CI - Docs build check / build-check (push) Successful in 8s
Build & publish docs (rc + release) / publish (push) Successful in 9s
2026-02-05 14:37:10 -06:00
dcfe8872de oops
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Build & publish docs (rc + release) / publish (push) Failing after 8s
2026-02-05 14:33:31 -06:00
1556b4fff7 fix
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Build & publish docs (rc + release) / publish (push) Failing after 39s
2026-02-05 14:26:08 -06:00
ffcd0f48aa fix
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Failing after 13s
Build & publish docs (rc + release) / release (push) Has been skipped
Build & publish docs (rc + release) / deploy (push) Has been skipped
2026-02-05 14:20:14 -06:00
ac93876087 fix
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 5s
Build & publish docs (rc + release) / release (push) Successful in 2s
Build & publish docs (rc + release) / deploy (push) Failing after 3s
2026-02-05 14:17:05 -06:00
368cf3edca fix
Some checks failed
CI - Docs build check / build-check (push) Successful in 9s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 5s
Build & publish docs (rc + release) / release (push) Successful in 2s
Build & publish docs (rc + release) / deploy (push) Failing after 3s
2026-02-05 14:12:26 -06:00
279a15f6ad fix
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 5s
Build & publish docs (rc + release) / release (push) Successful in 2s
Build & publish docs (rc + release) / deploy (push) Failing after 3s
2026-02-05 14:09:23 -06:00
69a34a5a82 test
Some checks failed
CI - Docs build check / build-check (push) Successful in 9s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 5s
Build & publish docs (rc + release) / release (push) Successful in 4s
Build & publish docs (rc + release) / deploy (push) Failing after 1s
2026-02-05 14:03:24 -06:00
7d7dbe5354 test
Some checks failed
CI - Docs build check / build-check (push) Successful in 13s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 5s
Build & publish docs (rc + release) / release (push) Successful in 2s
Build & publish docs (rc + release) / deploy (push) Failing after 2s
2026-02-05 13:58:19 -06:00
ddb44e9846 test
Some checks failed
CI - Docs build check / build-check (push) Successful in 7s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 6s
Build & publish docs (rc + release) / release (push) Successful in 2s
Build & publish docs (rc + release) / deploy (push) Successful in 1s
2026-02-05 13:47:59 -06:00
f1f4a69bd1 oops
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Failing after 4s
Build & publish docs (rc + release) / release (push) Has been skipped
Build & publish docs (rc + release) / deploy (push) Has been skipped
2026-02-05 13:40:06 -06:00
dea9106556 test
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
2026-02-05 13:35:51 -06:00
f7345b5433 test
Some checks failed
CI - Docs build check / build-check (push) Failing after 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
2026-02-05 13:30:06 -06:00
a5640d0e02 oops more errors 2026-02-05 13:25:56 -06:00
50252ece04 oops branch name wrong 2026-02-05 13:18:55 -06:00
0fa737e74b test 2026-02-05 13:17:33 -06:00
973dbefabb test 2026-02-05 13:01:37 -06:00
3 changed files with 123 additions and 84 deletions

View File

@@ -1,25 +1,26 @@
name: CI - Docs build check
on:
pull_request:
branches-ignore:
- gh-pages
push:
push:
branches:
- main
- develop
- release-candidate
workflow_dispatch:
permissions:
contents: read
env:
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT:-true }}
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
MKDOCS_CONFIG: mkdocs/mkdocs.yml
MKDOCS_OFFLINE: false
CSPELL_CONFIG: tools/spellcheck/cspell.yml
CSPELL_TARGETS: "docs/**/*.md" README.md
CSPELL_TARGETS: docs/**/*.md README.md
jobs:
build-check:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
@@ -33,7 +34,7 @@ jobs:
run: |
set -euo pipefail
npx --yes cspell \
--config ${CSPELL_CONFIG \
--config ${CSPELL_CONFIG} \
${CSPELL_TARGETS}
- name: Install build dependencies

View File

@@ -1,76 +0,0 @@
name: Deploy RC preview to GitHub Pages
on:
push:
tags: ["rc*"]
workflow_dispatch:
permissions:
contents: write
jobs:
deploy-rc-pages:
runs-on: ubuntu-latest
steps:
- name: Checkout (tag)
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install dependencies
run: |
set -euo pipefail
pip install -r mkdocs/requirements.txt
- name: Build site (strict default)
run: |
set -euo pipefail
export MKDOCS_STRICT="${MKDOCS_STRICT:-true}"
export TMPDIR="${RUNNER_TEMP:-$TMPDIR}"
export OUTPUT_DIR="${OUTPUT_DIR:-${TMPDIR}/dist/}"
tools/build.sh --config mkdocs/mkdocs.yml
- name: Checkout gh-pages branch
run: |
set -euo pipefail
git fetch origin gh-pages:gh-pages || true
if git show-ref --verify --quiet refs/heads/gh-pages; then
git switch gh-pages
else
git switch --orphan gh-pages
rm -rf ./*
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git commit --allow-empty -m "Initialize gh-pages"
fi
- name: Publish RC preview under /rc/<tag>/
run: |
export TMPDIR="${RUNNER_TEMP:-$TMPDIR}"
export OUTPUT_DIR="${OUTPUT_DIR:-${TMPDIR}/dist/}"
set -euo pipefail
rm -rf "rc"* || true
mkdir -p "rc/"
cp -a "$OUTPUT_DIR/." "rc/"
git add -A
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git commit -m "Deploy RC preview ${GITHUB_REF_NAME}" || echo "No changes to commit"
git push origin gh-pages
- name: Publish prerelease (GitHub)
uses: softprops/action-gh-release@v2
with:
prerelease: true
body: |
RC preview: https://<org>.github.io/<repo>/rc/
Tag: ${{ github.ref_name }}
Commit: ${{ github.sha }}

114
.github/workflows/release.yml vendored Normal file
View File

@@ -0,0 +1,114 @@
name: Build & publish docs (rc + release)
on:
push:
tags:
- "rc*"
- "v*"
workflow_dispatch:
permissions:
contents: write
env:
MKDOCS_CONFIG: mkdocs/mkdocs.yml
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
jobs:
publish:
runs-on: ubuntu-latest
steps:
- name: Checkout (tag)
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install deps
run: |
set -euo pipefail
pip install -r mkdocs/requirements.txt
- name: Build docs (normal + offline, strict gate)
run: |
set -euo pipefail
FLAGS=()
if [ "${MKDOCS_STRICT}" = "true" ]; then
FLAGS+=(--strict)
fi
OUT_BASE="${RUNNER_TEMP}/mkdocs_out"
SITE="${OUT_BASE}/site"
SITE_OFFLINE="${OUT_BASE}/site_offline"
rm -rf "${OUT_BASE}"
mkdir -p "${SITE}" "${SITE_OFFLINE}"
mkdocs build "${FLAGS[@]}" -f "${MKDOCS_CONFIG}" -d "${SITE}"
OFFLINE=true mkdocs build "${FLAGS[@]}" -f "${MKDOCS_CONFIG}" -d "${SITE_OFFLINE}"
- name: Zip offline site
run: |
set -euo pipefail
cd "${RUNNER_TEMP}/mkdocs_out"
zip -r "${GITHUB_REF_NAME}.zip" site_offline
- name: Publish prerelease
if: startsWith(github.ref_name, 'rc')
uses: softprops/action-gh-release@v2
with:
prerelease: true
name: ${{ github.ref_name }}
tag_name: ${{ github.ref_name }}
body: |
Release candidate preview (if deployed): /rc/
files: |
${{ runner.temp }}/mkdocs_out/${{ github.ref_name }}.zip
- name: Publish release
if: startsWith(github.ref_name, 'v')
uses: softprops/action-gh-release@v2
with:
name: ${{ github.ref_name }}
tag_name: ${{ github.ref_name }}
files: |
${{ runner.temp }}/mkdocs_out/${{ github.ref_name }}.zip
- name: Checkout gh-pages branch
uses: actions/checkout@v4
with:
ref: gh-pages
fetch-depth: 0
- name: Deploy release to gh-pages root
if: startsWith(github.ref_name, 'v')
run: |
set -euo pipefail
rm -rf ./*
cp -a ${RUNNER_TEMP}/mkdocs_out/site/. .
git add -A
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git commit -m "Deploy release ${GITHUB_REF_NAME}" || echo "No changes to commit"
git push origin gh-pages
- name: Deploy RC preview to /rc/
if: startsWith(github.ref_name, 'rc')
run: |
set -euo pipefail
rm -rf rc
mkdir -p rc
cp -a ${RUNNER_TEMP}/mkdocs_out/site/. rc/
printf '{"tag":"%s"}\n' "${GITHUB_REF_NAME}" > rc/rc.json
git add -A
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git commit -m "Deploy RC preview ${GITHUB_REF_NAME}" || echo "No changes to commit"
git push origin gh-pages