Skip to content

Merge pull request #123 from Linuxfabrik/dependabot/github_actions/ac… #50

Merge pull request #123 from Linuxfabrik/dependabot/github_actions/ac…

Merge pull request #123 from Linuxfabrik/dependabot/github_actions/ac… #50

Workflow file for this run

name: 'Linuxfabrik: Deploy API Documentation'
on:
push:
branches:
- 'main'
permissions:
contents: 'read'
pages: 'write'
id-token: 'write'
concurrency:
group: 'pages'
cancel-in-progress: true
jobs:
build:
runs-on: 'ubuntu-latest'
steps:
- name: 'Checkout repository'
uses: 'actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd' # v6.0.2
- name: 'Set up Python'
uses: 'actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405' # v6.2.0
with:
python-version: '3.12'
- name: 'Install dependencies'
run: |
pip install --editable .
pip install pdoc==16.0.0
- name: 'Build documentation'
run: 'pdoc --output-directory docs lib'
- name: 'Add .nojekyll'
run: 'touch docs/.nojekyll'
- name: 'Upload Pages artifact'
uses: 'actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b' # v4.0.0
with:
path: 'docs'
deploy:
needs: 'build'
runs-on: 'ubuntu-latest'
environment:
name: 'github-pages'
url: '${{ steps.deployment.outputs.page_url }}'
steps:
- name: 'Deploy to GitHub Pages'
id: 'deployment'
uses: 'actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128' # v5.0.0