Skip to content

Commit

Permalink
ci: add github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelrince committed Apr 18, 2024
1 parent ad208fe commit d16c01c
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/publish-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: publish-docs

on:
push:
branches:
- ci/publish-pypi

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
# check-out repo and set-up python
- name: Check out repository
uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- name: Set up python
id: setup-python
uses: actions/setup-python@v5
with:
python-version: "3.9"

# install & configure poetry
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
installer-parallel: true

# install dependencies if cache does not exist
- name: Install dependencies
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: poetry install --no-interaction --only docs

# deploy github pages
- name: Deploy GitHub Pages
run: mkdocs gh-deploy --force

0 comments on commit d16c01c

Please sign in to comment.