All checks were successful
website / build (push) Successful in 33s
Added a specific name ('docs') to the uploaded documentation artifact in the GitHub Actions workflow. This change makes the artifact easily identifiable in the GitHub Actions UI, improving the accessibility and management of build artifacts for developers and maintainers.
41 lines
880 B
YAML
41 lines
880 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: actions/upload-artifact@v3
|
|
with:
|
|
name: docs
|
|
path: docs
|
|
|