Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Generate [version] documentation | |
on: | |
release: | |
types: [published] | |
jobs: | |
build: | |
name: Deploy docs to GitHub Pages | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.11" | |
- name: Install dependencies | |
run: pip install -r docs/docs_requirements.txt | |
- name: Setup doc deploy | |
run: | | |
git config --global user.name Docs deploy | |
git config --global user.email [email protected] | |
- name: Set release notes tag | |
run: | | |
export RELEASE_TAG_VERSION="${{ github.event.release.tag_name }}" | |
echo RELEASE_TAG_VERSION="${RELEASE_TAG_VERSION:1}" >> "$GITHUB_ENV" | |
- name: Build docs website | |
run: mike deploy "${RELEASE_TAG_VERSION}" --push |