6 Commits

Author SHA1 Message Date
08c50299f0 Update RELEASING.md
All checks were successful
CI - Docs build check / build-check (push) Successful in 6s
2026-01-19 22:42:21 +00:00
27cb3e5c25 some fixes propagating to other workflows
All checks were successful
CI - Docs build check / build-check (push) Successful in 5s
Pre-release - Build and publish docs / prerelease (push) Successful in 9m7s
Release - Build and publish docs / release (push) Has been skipped
2026-01-19 14:47:52 -06:00
557a202a68 attempt setting env variable
Some checks failed
CI - Docs build check / build-check (push) Successful in 5s
Pre-release - Build and publish docs / prerelease (push) Failing after 4m36s
Release - Build and publish docs / release (push) Has been skipped
2026-01-19 14:30:42 -06:00
47485b05b2 disable cache, keep setup python
Some checks failed
CI - Docs build check / build-check (push) Failing after 21s
2026-01-19 14:26:45 -06:00
9b97a466bd test mkdocs_strict
Some checks failed
CI - Docs build check / build-check (push) Failing after 4s
2026-01-19 14:25:27 -06:00
a850448f0a skip pip cache. 2026-01-19 14:22:33 -06:00
4 changed files with 30 additions and 19 deletions

View File

@@ -10,6 +10,9 @@ on:
permissions: permissions:
contents: read contents: read
env:
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
jobs: jobs:
build-check: build-check:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@@ -19,11 +22,12 @@ jobs:
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Setup Python - name: Setup Python
# if: false
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:
python-version: "3.13" python-version: "3.11"
cache: "pip" # cache: "pip"
cache-dependency-path: mkdocs/requirements.txt # cache-dependency-path: mkdocs/requirements.txt
- name: Install dependencies - name: Install dependencies
run: | run: |
@@ -33,7 +37,7 @@ jobs:
- name: MkDocs build - name: MkDocs build
run: | run: |
set -euo pipefail set -euo pipefail
echo "MKDOCS_STRICT: $MKDOCS_STRICT"
MKDOCS_STRICT="${MKDOCS_STRICT:-true}" MKDOCS_STRICT="${MKDOCS_STRICT:-true}"
STRICT_FLAG="" STRICT_FLAG=""
if [ "${MKDOCS_STRICT}" = "true" ]; then if [ "${MKDOCS_STRICT}" = "true" ]; then

View File

@@ -8,6 +8,9 @@ on:
permissions: permissions:
contents: write contents: write
env:
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
jobs: jobs:
prerelease: prerelease:
@@ -53,7 +56,7 @@ jobs:
STRICT_FLAG="--strict" STRICT_FLAG="--strict"
fi fi
OFFLINE=true mkdocs build ${STRICT_FLAG} -f mkdocs/mkdocs.yml OFFLINE=true mkdocs build ${STRICT_FLAG} -f mkdocs/mkdocs.yml -d $RUNNER_TEMP
- name: Build artifact (non-strict) - name: Build artifact (non-strict)
env: env:

View File

@@ -7,6 +7,9 @@ on:
permissions: permissions:
contents: write contents: write
env:
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
jobs: jobs:
release: release:
@@ -52,7 +55,7 @@ jobs:
STRICT_FLAG="--strict" STRICT_FLAG="--strict"
fi fi
OFFLINE=true mkdocs build ${STRICT_FLAG} -f mkdocs/mkdocs.yml OFFLINE=true mkdocs build ${STRICT_FLAG} -f mkdocs/mkdocs.yml -d $RUNNER_TEMP
- name: Build artifact (non-strict) - name: Build artifact (non-strict)
env: env:

View File

@@ -65,13 +65,13 @@ This naming policy is intentional and is enforced by CI.
## CI and Workflows Overview ## CI and Workflows Overview
| Workflow | Trigger | Purpose | | Workflow | Trigger | Purpose |
|———|———|———| |-------------------|----------------------------------|----------------------------------------|
| CI Docs | Push / PR to `release-candidate` | Strict MkDocs build validation | | CI Docs | Push / PR to `release-candidate` | Strict MkDocs build validation |
| Prerelease | Tag `v*` containing `-rc` | Build and publish prerelease artifacts | | Prerelease | Tag `v*` containing `-rc` | Build and publish prerelease artifacts |
| Release | Tag `v*` not containing `-rc` | Build and publish final release | | Release | Tag `v*` not containing `-rc` | Build and publish final release |
| RC Pages Deploy | RC tag | Publish preview docs under `/rc/<tag>/` | | RC Pages Deploy | RC tag | Publish preview docs under `/rc//` |
| Main Pages Deploy | Push to `main` | Publish stable docs to root | | Main Pages Deploy | Push to `main` | Publish stable docs to root |
@@ -116,12 +116,13 @@ This redundancy is intentional.
These variables control CI and release behavior: These variables control CI and release behavior:
| Variable | Purpose | | Variable | Purpose |
|———|———| |-------------------|-------------------------------------|
| `MKDOCS_STRICT` | Enable/disable strict MkDocs builds | | `MKDOCS_STRICT` | Enable/disable strict MkDocs builds |
| `ENABLE_RELEASE` | Master switch for releases | | `ENABLE_RELEASE` | Master switch for releases |
| `ENABLE_DEPLOY` | Master switch for deployments | | `ENABLE_DEPLOY` | Master switch for deployments |
| `CI_PROVIDER` | `github`, `gitea`, or `act` | | `CI_PROVIDER` | `github`, `gitea`, or `act` |
| Main Pages Deploy | Push to `main` |
Defaults are defined in repository settings. Defaults are defined in repository settings.