Skip to content

ci(github-actions): 👷 add CI config for docs site #1

ci(github-actions): 👷 add CI config for docs site

ci(github-actions): 👷 add CI config for docs site #1

Workflow file for this run

name: Documentation Site
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# 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
concurrency:
group: "pages"
cancel-in-progress: false
# Adopted from https://squidfunk.github.io/mkdocs-material/publishing-your-site/?h=pages#with-github-actions,
# using native GitHub Action for GH Pages instead of "mkdocs gh-pages".
jobs:
build:
name: Build docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: |
pip install pipenv
pipenv install
- run: mkdocs build -d ./public
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./public
deploy:
name: 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@v4