6 Commits

Author SHA1 Message Date
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
2 changed files with 102 additions and 8 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

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

@@ -0,0 +1,93 @@
name: Build & publish docs (rc + release)
on:
push:
tags:
- "rc*"
- "v*"
workflow_dispatch:
permissions:
contents: read
env:
MKDOCS_CONFIG: mkdocs/mkdocs.yml
MKDOCS_OUTPUT_DIR: ${{ runner.temp }}/dist
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- 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 (strict gate)
run: |
set -euo pipefail
FLAGS=()
if [ "${MKDOCS_STRICT}" = "true" ]; then
FLAGS+=(--strict)
fi
mkdir -p "${MKDOCS_OUTPUT_DIR}"
OFFLINE="${OFFLINE}" mkdocs build \
"${FLAGS[@]}" \
-f "${MKDOCS_CONFIG}" \
-d "${MKDOCS_OUTPUT_DIR}"
- name: Zip site
run: |
set -euo pipefail
cd "${MKDOCS_OUTPUT_DIR}"
zip -r "${GITHUB_REF_NAME}.zip" .
release:
runs-on: ubuntu-latest
needs: build
steps:
# -------------------------
# RC-only step
# -------------------------
- 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 }}/${{ github.ref_name }}.zip
# -------------------------
# Final release-only step
# -------------------------
- 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 }}/${{ github.ref_name }}.zip
deploy:
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy
run: |
echo "TBD :)"