Version bump #25
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: website | |
# 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@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.11" | |
- name: Install Dependencies | |
run: | | |
python -m venv venv | |
source venv/bin/activate | |
pip install -r requirements.txt | |
- name: Build documentation | |
run: pip install pdoc==7.3.0 && pdoc --docformat google src/domsdatabasen -o docs | |
- name: Compress documentation | |
run: tar --directory docs/ -hcf artifact.tar . | |
- name: Upload documentation | |
uses: actions/upload-artifact@v3 | |
with: | |
name: github-pages | |
path: ./artifact.tar | |
# 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@v1 |