5 Commits

Author SHA1 Message Date
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
3 changed files with 40 additions and 212 deletions

View File

@@ -1,74 +0,0 @@
name: Release - Build and publish docs
on:
push:
tags: ["v*"]
workflow_dispatch:
permissions:
contents: write
jobs:
release:
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: CI gate build (strict)
env:
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT }}
run: |
set -euo pipefail
export MKDOCS_STRICT="${MKDOCS_STRICT:-true}"
tools/mkdocs_build.sh --config mkdocs/mkdocs.yml
- name: Package site (non-strict)
run: |
set -euo pipefail
export MKDOCS_STRICT="false"
scripts/package_site.sh "${GITHUB_REF_NAME}" --config mkdocs/mkdocs.yml --dist "${RUNNER_TEMP}/dist"
- name: Publish release (GitHub)
uses: softprops/action-gh-release@v2
with:
name: ${{ github.ref_name }}
tag_name: ${{ github.ref_name }}
files: |
${{ runner.temp }}/dist/${{ github.ref_name }}.zip
- name: Remove RC preview from gh-pages (optional cleanup)
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
echo "No gh-pages branch; nothing to clean."
exit 0
fi
if [ -d rc ]; then
rm -rf rc
git add -A
git config user.name "actions-bot"
git config user.email "actions-bot@users.noreply.github.com"
git commit -m "Remove RC preview after release ${GITHUB_REF_NAME}" || echo "No changes to commit"
git push origin gh-pages
else
echo "No rc/ directory present; nothing to delete."
fi

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 }}

View File

@@ -8,22 +8,24 @@ on:
workflow_dispatch: workflow_dispatch:
permissions: permissions:
contents: read contents: write
env: env:
MKDOCS_CONFIG: mkdocs/mkdocs.yml MKDOCS_CONFIG: mkdocs/mkdocs.yml
MKDOCS_OUTPUT_DIR: ${{ runner.temp }}/dist
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }} MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
jobs: jobs:
build: publish:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - name: Checkout (tag)
uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
- uses: actions/setup-python@v5 - name: Setup Python
uses: actions/setup-python@v5
with: with:
python-version: "3.11" python-version: "3.11"
@@ -32,7 +34,7 @@ jobs:
set -euo pipefail set -euo pipefail
pip install -r mkdocs/requirements.txt pip install -r mkdocs/requirements.txt
- name: Build docs (strict gate) - name: Build docs (normal + offline, strict gate)
run: | run: |
set -euo pipefail set -euo pipefail
@@ -41,34 +43,23 @@ jobs:
FLAGS+=(--strict) FLAGS+=(--strict)
fi fi
mkdir -p "${MKDOCS_OUTPUT_DIR}" OUT_BASE="${RUNNER_TEMP}/mkdocs_out"
SITE="${OUT_BASE}/site"
SITE_OFFLINE="${OUT_BASE}/site_offline"
OFFLINE="${OFFLINE:-true}" mkdocs build \ rm -rf "${OUT_BASE}"
"${FLAGS[@]}" \ mkdir -p "${SITE}" "${SITE_OFFLINE}"
-f "${MKDOCS_CONFIG}" \
-d "${MKDOCS_OUTPUT_DIR}/offline"
mkdocs build \
"${FLAGS[@]}" \
-f "${MKDOCS_CONFIG}" \
-d "${MKDOCS_OUTPUT_DIR}/dist"
- name: Zip site mkdocs build "${FLAGS[@]}" -f "${MKDOCS_CONFIG}" -d "${SITE}"
OFFLINE=true mkdocs build "${FLAGS[@]}" -f "${MKDOCS_CONFIG}" -d "${SITE_OFFLINE}"
- name: Zip offline site
run: | run: |
set -euo pipefail set -euo pipefail
cd "${MKDOCS_OUTPUT_DIR}" cd "${RUNNER_TEMP}/mkdocs_out"
zip -r "${GITHUB_REF_NAME}.zip" "./offline" zip -r "${GITHUB_REF_NAME}.zip" site_offline
release:
runs-on: ubuntu-latest - name: Publish prerelease
needs: build
steps:
- name: Checkout (tag)
uses: actions/checkout@v4
with:
fetch-depth: 0
# -------------------------
# RC-only step
# -------------------------
- name: Publish prerelease
if: startsWith(github.ref_name, 'rc') if: startsWith(github.ref_name, 'rc')
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2
with: with:
@@ -78,11 +69,8 @@ jobs:
body: | body: |
Release candidate preview (if deployed): /rc/ Release candidate preview (if deployed): /rc/
files: | files: |
${{ runner.temp }}/${{ github.ref_name }}.zip ${{ runner.temp }}/mkdocs_out/${{ github.ref_name }}.zip
# -------------------------
# Final release-only step
# -------------------------
- name: Publish release - name: Publish release
if: startsWith(github.ref_name, 'v') if: startsWith(github.ref_name, 'v')
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2
@@ -90,47 +78,37 @@ jobs:
name: ${{ github.ref_name }} name: ${{ github.ref_name }}
tag_name: ${{ github.ref_name }} tag_name: ${{ github.ref_name }}
files: | files: |
${{ runner.temp }}/${{ github.ref_name }}.zip ${{ runner.temp }}/mkdocs_out/${{ github.ref_name }}.zip
deploy:
runs-on: ubuntu-latest
needs: build
steps:
- name: Checkout gh-pages branch - 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: | run: |
set -euo pipefail set -euo pipefail
git fetch origin gh-pages:gh-pages || true rm -rf ./*
if git show-ref --verify --quiet refs/heads/gh-pages; then cp -a ../mkdocs_out/site/. .
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 release
run: |
set -euo pipefail
rm ./* ./.* || true
cp -a "${MKDOCS_OUTPUT_DIR}/dist/." ""
git add -A git add -A
git config user.name "github-actions[bot]" git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com" 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 commit -m "Deploy release ${GITHUB_REF_NAME}" || echo "No changes to commit"
git push origin gh-pages git push origin gh-pages
- name: Publish RC preview under /rc/<tag>/ - name: Deploy RC preview to /rc/
if: startsWith(github.ref_name, 'rc')
run: | run: |
set -euo pipefail set -euo pipefail
rm -rf "rc"* || true rm -rf rc
mkdir -p "rc/" mkdir -p rc
cp -a "${MKDOCS_OUTPUT_DIR}/dist/." "rc/" cp -a ../mkdocs_out/site/. rc/
printf '{"tag":"%s"}\n' "${GITHUB_REF_NAME}" > rc/rc.json
git add -A git add -A
git config user.name "github-actions[bot]" git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com" 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 commit -m "Deploy RC preview ${GITHUB_REF_NAME}" || echo "No changes to commit"
git push origin gh-pages git push origin gh-pages