Skip to content

Update workflows

Update workflows #25

Workflow file for this run

name: "Deploy Documentation"
# build the documentation whenever there are new commits on main
on:
push:
branches:
- main
# security: restrict permissions for CI jobs.
permissions:
contents: read
jobs:
# Build the documentation and upload the static HTML files as an artifact.
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.2
- uses: actions/setup-python@v4
with:
python-version: '3.12'
- name: Build docs
run: |
pip install .
pip install pdoc
pdoc ./onboardapis -o docs --math --logo-link "https://felix-zenk.github.io/onboardapis/docs"
- name: Fix permissions
run: |
chmod -c -R +rX "docs/" | while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
- uses: actions/upload-pages-artifact@v2
with:
path: docs/
# Deploy the artifact to GitHub pages.
# This is a separate job so that only actions/deploy-pages has the necessary permissions.
deploy:
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v3