mirror of
https://github.com/Vateron-Media/XC_VM.git
synced 2026-10-04 12:02:33 +02:00
Divarion_D
abcb09c120
Add a version selector to the docs and publish one snapshot per release instead of a single rolling site, so readers can pick the docs matching their installed version (the docs change release to release). - mkdocs.yml: enable the Material version selector (extra.version.provider: mike, alias: true). - docs/requirements.txt: add mike==2.1.3. - pages.yml: deploy with mike, triggered by a release TAG (semver) instead of every push to main — publishing is tied to the release because docs/ru is only regenerated then. Deploys `X.Y.Z` + the `latest` alias to the gh-pages branch and sets latest as default. workflow_dispatch takes an explicit version. - updates_checklist.md: note the tag-triggered versioned publish. One-time setup (GitHub UI): Settings → Pages → Deploy from a branch → gh-pages.
70 lines
2.3 KiB
YAML
70 lines
2.3 KiB
YAML
name: Deploy versioned docs to Pages
|
|
|
|
# Publishes the MkDocs (Material) site to the `gh-pages` branch as a VERSIONED
|
|
# snapshot with mike — one entry per release tag (e.g. 2.4.2), plus a `latest`
|
|
# alias that always points at the newest and is the default landing version.
|
|
#
|
|
# English (docs/en) is the single source you edit; Russian (docs/ru) is a
|
|
# GENERATED tree, committed and refreshed LOCALLY before a release
|
|
# (`make docs-translate`) — translation is intentionally NOT run in CI. Because
|
|
# docs/ru is only regenerated at release time, publishing is tied to the release
|
|
# TAG (not every push to main): docs merged to main between releases go live at
|
|
# the next tagged release, alongside the freshly regenerated Russian tree.
|
|
#
|
|
# One-time setup: Settings → Pages → Build and deployment → Deploy from a branch
|
|
# → branch `gh-pages` / `/ (root)`. mike owns that branch (it also writes
|
|
# `versions.json`, which the Material version selector reads).
|
|
on:
|
|
push:
|
|
tags:
|
|
- '[0-9]+.[0-9]+.[0-9]+'
|
|
workflow_dispatch:
|
|
inputs:
|
|
version:
|
|
description: 'Version to (re)deploy, e.g. 2.4.2'
|
|
required: true
|
|
|
|
# mike commits and pushes the built site to the gh-pages branch.
|
|
permissions:
|
|
contents: write
|
|
|
|
# Never run two doc deploys at once; queue instead (mike appends to gh-pages).
|
|
concurrency:
|
|
group: docs-mike
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
deploy:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v7
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v7
|
|
with:
|
|
python-version: '3.12'
|
|
|
|
- name: Install docs build toolchain
|
|
run: pip install -r docs/requirements.txt
|
|
|
|
- name: Resolve version
|
|
id: ver
|
|
run: echo "version=${{ github.event.inputs.version || github.ref_name }}" >> "$GITHUB_OUTPUT"
|
|
|
|
- name: Strict build check
|
|
run: mkdocs build --strict
|
|
|
|
- name: Configure git identity
|
|
run: |
|
|
git config user.name "github-actions[bot]"
|
|
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
|
|
|
- name: Deploy version + latest alias with mike
|
|
run: |
|
|
git fetch origin gh-pages --depth=1 || true
|
|
mike deploy --push --update-aliases "${{ steps.ver.outputs.version }}" latest
|
|
mike set-default --push latest
|