Skip to content

publish

publish #20

Workflow file for this run

name: publish
# Builds the MkDocs site from fastsqs/fastsqs and deploys via Pages OIDC.
# No credentials involved: the org disabled deploy keys, so publication moved
# here from fastsqs/fastsqs docs.yml. Trigger manually after a release, or
# wait for the daily cron.
on:
workflow_dispatch:
schedule:
- cron: '17 3 * * *'
permissions: {}
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
name: build docs from fastsqs/fastsqs
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v4
with:
repository: fastsqs/fastsqs
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install docs dependencies
run: |
python -m pip install --upgrade pip
pip install -e ".[docs]"
- name: Build site (strict)
run: mkdocs build --strict
- uses: actions/upload-pages-artifact@v3
with:
path: ./site
deploy:
name: deploy to github pages
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4