docs: update deploy workflow (#124)

Co-authored-by: damienrj <damien@squareup.com>
This commit is contained in:
lily-de
2024-10-08 13:37:21 -04:00
committed by GitHub
parent 0d1808d005
commit 5029b195e2
5 changed files with 195 additions and 30 deletions

View File

@@ -4,9 +4,11 @@ on:
push:
branches:
- main # Trigger deployment on pushes to main
paths:
- 'docs/**'
- 'mkdocs.yml'
- '.github/workflows/deploy_docs.yaml'
jobs:
deploy:
@@ -14,27 +16,10 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install \
mkdocs \
mkdocs-callouts \
mkdocs-include-markdown-plugin \
mkdocs-material
- name: Install UV
uses: astral-sh/setup-uv@v3
- name: Build the documentation
run: mkdocs build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
run: uv run mkdocs gh-deploy --force