Skip to content

Publish docs

Publish docs #23

Workflow file for this run

name: Publish docs
on:
push:
tags: # See PEP 440 for valid version format
- "*.*.*" # For docs bump, use workflow_dispatch
branches:
- test_branch
workflow_dispatch: # Manually trigger with 'Run workflow' button
permissions:
contents: write
pull-requests: write
issues: write
repository-projects: write
jobs:
deploy:
runs-on: ubuntu-latest
env:
REPO_OWNER: ${{ github.repository_owner }}
permissions:
contents: write
issues: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0
- name: Git describe # Get tags
id: ghd
uses: proudust/gh-describe@v2
- name: Check tag
run: |
echo "describe : ${{ steps.ghd.outputs.describe }}"
echo "tag : ${{ steps.ghd.outputs.tag }}"
echo "distance : ${{ steps.ghd.outputs.distance }}"
echo "sha : ${{ steps.ghd.outputs.sha }}"
echo "short-sha : ${{ steps.ghd.outputs.short-sha }}"
- name: Set up Python runtime
uses: actions/setup-python@v5
with:
python-version: 3.9
token: ${{ secrets.GITHUB_TOKEN }}
- name: Setup - pip & config
run: |
pip install .[docs]
git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
- name: Deploy
run: | # github.ref_name is branch name if dispatch
FULL_VERSION=${{ steps.ghd.outputs.tag }}
export MAJOR_VERSION=${FULL_VERSION:0:3}
echo "OWNER: ${REPO_OWNER}. BUILD: ${MAJOR_VERSION}"
bash ./docs/build-docs.sh push $REPO_OWNER
env:
USERNAME: github-actions[bot]
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}