Skip to content

Merge pull request #103 from ydb-platform/fix/order-by-constant-and-s… #71

Merge pull request #103 from ydb-platform/fix/order-by-constant-and-s…

Merge pull request #103 from ydb-platform/fix/order-by-constant-and-s… #71

Workflow file for this run

# GitHub Actions workflow for building and deploying Sphinx documentation to GitHub Pages
name: Documentation
on:
push:
branches: ["main"]
paths:
- "docs/**"
- "pyproject.toml"
- ".github/workflows/docs.yml"
pull_request:
branches: ["main"]
paths:
- "docs/**"
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
- name: Load cached venv
id: cached-poetry-dependencies
uses: actions/cache@v4
with:
path: .venv
key: venv-docs-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
- name: Install dependencies
run: poetry install --only docs --no-interaction
- name: Build documentation
run: |
cd docs
poetry run make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html
# Deployment job (only on main branch push)
deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4