Compare commits
6 Commits
fb4b4be4d0
...
release-ca
| Author | SHA1 | Date | |
|---|---|---|---|
| 08c50299f0 | |||
| 27cb3e5c25 | |||
| 557a202a68 | |||
| 47485b05b2 | |||
| 9b97a466bd | |||
| a850448f0a |
12
.github/workflows/ci-docs.yml
vendored
12
.github/workflows/ci-docs.yml
vendored
@@ -10,6 +10,9 @@ on:
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
env:
|
||||
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
|
||||
|
||||
jobs:
|
||||
build-check:
|
||||
runs-on: ubuntu-latest
|
||||
@@ -19,11 +22,12 @@ jobs:
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Python
|
||||
# if: false
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: "3.13"
|
||||
cache: "pip"
|
||||
cache-dependency-path: mkdocs/requirements.txt
|
||||
python-version: "3.11"
|
||||
# cache: "pip"
|
||||
# cache-dependency-path: mkdocs/requirements.txt
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
@@ -33,7 +37,7 @@ jobs:
|
||||
- name: MkDocs build
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
echo "MKDOCS_STRICT: $MKDOCS_STRICT"
|
||||
MKDOCS_STRICT="${MKDOCS_STRICT:-true}"
|
||||
STRICT_FLAG=""
|
||||
if [ "${MKDOCS_STRICT}" = "true" ]; then
|
||||
|
||||
5
.github/workflows/prerelease-docs.yml
vendored
5
.github/workflows/prerelease-docs.yml
vendored
@@ -8,6 +8,9 @@ on:
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
env:
|
||||
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
|
||||
|
||||
jobs:
|
||||
prerelease:
|
||||
@@ -53,7 +56,7 @@ jobs:
|
||||
STRICT_FLAG="--strict"
|
||||
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)
|
||||
env:
|
||||
|
||||
5
.github/workflows/release-docs.yml
vendored
5
.github/workflows/release-docs.yml
vendored
@@ -7,6 +7,9 @@ on:
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
env:
|
||||
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
|
||||
|
||||
jobs:
|
||||
release:
|
||||
@@ -52,7 +55,7 @@ jobs:
|
||||
STRICT_FLAG="--strict"
|
||||
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)
|
||||
env:
|
||||
|
||||
27
RELEASING.md
27
RELEASING.md
@@ -65,13 +65,13 @@ This naming policy is intentional and is enforced by CI.
|
||||
|
||||
## CI and Workflows Overview
|
||||
|
||||
| Workflow | Trigger | Purpose |
|
||||
|———|———|———|
|
||||
| CI Docs | Push / PR to `release-candidate` | Strict MkDocs build validation |
|
||||
| Prerelease | Tag `v*` containing `-rc` | Build and publish prerelease artifacts |
|
||||
| Release | Tag `v*` not containing `-rc` | Build and publish final release |
|
||||
| RC Pages Deploy | RC tag | Publish preview docs under `/rc/<tag>/` |
|
||||
| Main Pages Deploy | Push to `main` | Publish stable docs to root |
|
||||
| Workflow | Trigger | Purpose |
|
||||
|-------------------|----------------------------------|----------------------------------------|
|
||||
| CI Docs | Push / PR to `release-candidate` | Strict MkDocs build validation |
|
||||
| Prerelease | Tag `v*` containing `-rc` | Build and publish prerelease artifacts |
|
||||
| Release | Tag `v*` not containing `-rc` | Build and publish final release |
|
||||
| RC Pages Deploy | RC tag | Publish preview docs under `/rc//` |
|
||||
| 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:
|
||||
|
||||
| Variable | Purpose |
|
||||
|———|———|
|
||||
| `MKDOCS_STRICT` | Enable/disable strict MkDocs builds |
|
||||
| `ENABLE_RELEASE` | Master switch for releases |
|
||||
| `ENABLE_DEPLOY` | Master switch for deployments |
|
||||
| `CI_PROVIDER` | `github`, `gitea`, or `act` |
|
||||
| Variable | Purpose |
|
||||
|-------------------|-------------------------------------|
|
||||
| `MKDOCS_STRICT` | Enable/disable strict MkDocs builds |
|
||||
| `ENABLE_RELEASE` | Master switch for releases |
|
||||
| `ENABLE_DEPLOY` | Master switch for deployments |
|
||||
| `CI_PROVIDER` | `github`, `gitea`, or `act` |
|
||||
| Main Pages Deploy | Push to `main` |
|
||||
|
||||
Defaults are defined in repository settings.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user