Merge pull request #9 from gattia/dev #20
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, master] | |
# Alternative: only build for tags. | |
# tags: | |
# - '*' | |
# 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 | |
- uses: actions/setup-python@v3 | |
# ADJUST THIS: install all dependencies (including pdoc) | |
# install ninja-build because its required for itk install | |
# https://stackoverflow.com/questions/59086665/pycharm-unable-to-install-itk-package-cmake-gives-an-error | |
- name: Install dependencies | |
run: | | |
sudo apt-get install ninja-build | |
python -m pip install --upgrade pip | |
make dev | |
# ADJUST THIS: build your documentation into docs/. | |
- run: make docs | |
# We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. | |
- run: tar --directory docs/ -hcf artifact.tar . | |
- 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 |