Skip to content

Commit

Permalink
feat: Add release docs, too!
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholasyager committed Nov 24, 2024
1 parent 6d10926 commit 038eaf3
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/publish-docs-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Publish MkDocs on Release

on:
release:
types:
- published

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.9

- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
pip install poetry
poetry install --with=docs
- name: Extract Major and Minor Version
run: |
VERSION_TAG=${{ github.event.release.tag_name }}
VERSION_TAG="${VERSION_TAG#v}" # Remove 'v' prefix if present
MAJOR="${VERSION_TAG%%.*}"
MINOR="${VERSION_TAG#*.}"
MINOR="${MINOR%%.*}"
MAJOR_MINOR_VERSION="${MAJOR}.${MINOR}"
echo "MAJOR_MINOR_VERSION=${MAJOR_MINOR_VERSION}" >> $GITHUB_ENV
- name: Deploy Updated Docs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
git config user.name "GitHub Actions"
git config user.email "[email protected]"
poetry run mike deploy --push --message "Deploy docs for release ${{ github.event.release.tag_name }}" --update-alias $MAJOR_MINOR_VERSION latest
poetry run mike set-default --push latest

0 comments on commit 038eaf3

Please sign in to comment.