Skip to content

Commit

Permalink
Add pages CD
Browse files Browse the repository at this point in the history
  • Loading branch information
hypergonial committed Jan 20, 2024
1 parent 98ab59e commit f6152a7
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Deploy docs to Pages

on:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Run on push
push:
branches:
- main
- feature/docs-v3

# 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

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

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

- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: "3.11"

- name: Build docs via nox
run: |
python -m pip install nox
python -m nox -s mkdocs
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./site

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

0 comments on commit f6152a7

Please sign in to comment.