79f9967eaa
Motivation Upgrades Sphinx to 9.x, MyST Parser to 5.x, Python to 3.11+–3.14, Node.js to 22, and replaces Poetry with uv for dependency management. Changelog: https://github.com/scylladb/sphinx-scylladb-theme/blob/master/docs/source/upgrade/CHANGELOG.md#190---26-february-2026 How to test * Make sure you are using Python 3.11-3.14: * python --version * Install uv: * make setupenv * Build the docs: * make preview * Docs should render without errors at http://127.0.0.1:5500 Closes scylladb/scylladb#28971
50 lines
1.5 KiB
YAML
50 lines
1.5 KiB
YAML
name: "Docs / Publish"
|
|
# For more information,
|
|
# see https://sphinx-theme.scylladb.com/stable/deployment/production.html#available-workflows
|
|
|
|
env:
|
|
FLAG: ${{ github.repository == 'scylladb/scylla-enterprise' && 'enterprise' || 'opensource' }}
|
|
DEFAULT_BRANCH: ${{ github.repository == 'scylladb/scylla-enterprise' && 'enterprise' || 'master' }}
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- 'master'
|
|
- 'enterprise'
|
|
- 'branch-**'
|
|
paths:
|
|
- "docs/**"
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
release:
|
|
permissions:
|
|
pages: write
|
|
id-token: write
|
|
contents: write
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
ref: ${{ env.DEFAULT_BRANCH }}
|
|
persist-credentials: false
|
|
fetch-depth: 0
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "3.12"
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@v6
|
|
- name: Set up env
|
|
run: make -C docs FLAG="${{ env.FLAG }}" setupenv
|
|
- name: Build docs
|
|
run: make -C docs FLAG="${{ env.FLAG }}" multiversion
|
|
- name: Build redirects
|
|
run: make -C docs FLAG="${{ env.FLAG }}" redirects
|
|
- name: Deploy docs to GitHub Pages
|
|
run: ./docs/_utils/deploy.sh
|
|
if: (github.ref_name == 'master' && env.FLAG == 'opensource') || (github.ref_name == 'enterprise' && env.FLAG == 'enterprise')
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|