Skip to content

Commit

Permalink
Build and deploy documentation to docs.jumpstarter.dev
Browse files Browse the repository at this point in the history
  • Loading branch information
mangelajo committed Aug 7, 2024
1 parent 4e2dd0b commit 7dc0a58
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 0 deletions.
78 changes: 78 additions & 0 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: documentation

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
pull_request:

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

defaults:
run:
shell: bash

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Install Python
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install poetry
uses: abatilo/actions-poetry@v2

- uses: actions/cache@v3
name: Define a cache for the virtual environment based on the dependencies lock file
with:
path: ./.venv
key: venv-${{ hashFiles('poetry.lock') }}

- name: Fix lock?
run: poetry lock

- name: Setup Pages
id: pages
uses: actions/configure-pages@v3

- name: Install the project dependencies
run: poetry install --all-extras

- name: Build the documentation
run: poetry run make docs

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./docs/build/html

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/main'
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
docs:
cd docs && make html

.PHONY: docs

0 comments on commit 7dc0a58

Please sign in to comment.