Skip to content

Merge pull request #20 from NHagar/NHagar/add-cli #39

Merge pull request #20 from NHagar/NHagar/add-cli

Merge pull request #20 from NHagar/NHagar/add-cli #39

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- master
pull_request:
branches:
- master
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.12'
- name: Install uv
run: |
curl -LsSf https://astral.sh/uv/install.sh | sh
echo "$HOME/.cargo/bin" >> $GITHUB_PATH
- name: Setup uv cache
uses: actions/cache@v3
with:
path: ~/.cache/uv
key: ${{ runner.os }}-uv-${{ hashFiles('pyproject.toml') }}
restore-keys: |
${{ runner.os }}-uv-
- name: Install dependencies
run: |
uv sync
- name: Configure Git user
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- name: Deploy documentation
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
run: |
uv run mkdocs gh-deploy --force
- name: Build documentation (PR)
if: github.event_name == 'pull_request'
run: uv run mkdocs build