forked from phoenix-oss/llama-stack-mirror
33a64eb5ec
# What does this PR do? Refine the existing update-readthedocs.yml workflow to enhance automation and reliability. Updates include: - Expanding path triggers to cover all documentation files (docs/**) and build artifacts. - Adding steps to set up Python (3.11), install uv, sync dependencies, and build HTML using make html. - Ensuring the ReadTheDocs build trigger only runs on workflow_dispatch events. These improvements help validate website builds in PRs, preventing issues before merging. Signed-off-by: Sébastien Han <seb@redhat.com> Signed-off-by: Sébastien Han <seb@redhat.com>
65 lines
1.5 KiB
YAML
65 lines
1.5 KiB
YAML
name: Update ReadTheDocs
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
inputs:
|
|
branch:
|
|
description: 'RTD version to update'
|
|
required: false
|
|
default: 'latest'
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- 'docs/**'
|
|
- '.github/workflows/update-readthedocs.yml'
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- 'docs/**'
|
|
- '.github/workflows/update-readthedocs.yml'
|
|
|
|
jobs:
|
|
update-readthedocs:
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
TOKEN: ${{ secrets.READTHEDOCS_TOKEN }}
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.11'
|
|
|
|
- name: Install the latest version of uv
|
|
uses: astral-sh/setup-uv@v5
|
|
|
|
- name: Sync with uv
|
|
run: uv sync --extra docs
|
|
|
|
- name: Build HTML
|
|
run: |
|
|
cd docs
|
|
uv run make html
|
|
|
|
- name: Trigger ReadTheDocs build
|
|
if: github.event_name != 'pull_request'
|
|
run: |
|
|
if [ -z "$TOKEN" ]; then
|
|
echo "READTHEDOCS_TOKEN is not set"
|
|
exit 1
|
|
fi
|
|
|
|
response=$(curl -X POST \
|
|
-H "Content-Type: application/json" \
|
|
-d "{\"token\": \"$TOKEN\"}" \
|
|
https://readthedocs.org/api/v2/webhook/llama-stack/289768/)
|
|
|
|
echo "Response: $response"
|
|
if [ $(echo $response | jq -r '.build_triggered') != 'true' ]; then
|
|
echo "Failed to trigger ReadTheDocs build"
|
|
exit 1
|
|
fi
|