Kumi
2bef3bb119
Some checks failed
website / build (push) Failing after 32s
Replaced custom git pull command with `actions/checkout@v4` in the pdoc documentation generation workflow. This change streamlines the checkout process, leveraging a more robust and standardized approach provided by GitHub Actions. It ensures compatibility and potential performance improvements in our CI/CD pipeline.
40 lines
859 B
YAML
40 lines
859 B
YAML
name: website
|
|
|
|
# build the documentation whenever there are new commits on main
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
# Alternative: only build for tags.
|
|
# tags:
|
|
# - '*'
|
|
workflow_dispatch:
|
|
## security: restrict permissions for CI jobs.
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
# Build the documentation and upload the static HTML files as an artifact.
|
|
build:
|
|
container:
|
|
image: node:20-bookworm
|
|
steps:
|
|
- name: Install dependencies
|
|
run: |
|
|
apt update
|
|
apt install -y python3 python3-pip git
|
|
|
|
- name: Git pull
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Install Python dependencies
|
|
run: |
|
|
pip install pdoc . --break-system-packages
|
|
|
|
- run: python3 -m pdoc -d markdown -o docs plankapy
|
|
|
|
- uses: forgejo/upload-artifact@v4
|
|
with:
|
|
path: docs
|
|
|