Skip to content

Merge pull request #6 from znd4/pre-commit-ci-update-config #8

Merge pull request #6 from znd4/pre-commit-ci-update-config

Merge pull request #6 from znd4/pre-commit-ci-update-config #8

Workflow file for this run

name: Documentation
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
paths:
- "*.md"
- docs/**
# 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
jobs:
build-doc:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: pdm-project/setup-pdm@main
with:
python-version: 3.x
cache: true
- uses: actions/cache@v3
id: hatch-cache
with:
# cache to runner
path: hatch-cache
key: ${{ hashFiles('pyproject.toml') }}
- name: Build pages
run: |
hatch run \
--cache-dir=hatch-cache \
docs:build
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: ./docs/site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2