Merge pull request #26 from geneontology/pr-docs-permissions #16
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: Auto-deployment of gocam Documentation | |
on: | |
push: | |
branches: [main] | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
permissions: | |
contents: write # to let mkdocs write the new docs | |
pages: write # to deploy to Pages | |
id-token: write # to verify the deployment originates from an appropriate source | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 # otherwise, it will fail to push refs to dest repo | |
- name: Install Poetry | |
run: pipx install poetry | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.12' | |
cache: 'poetry' | |
- name: Install dependencies | |
run: poetry install | |
- name: Build documentation | |
run: | | |
mkdir -p docs | |
touch docs/.nojekyll | |
make gendoc | |
([ ! -f docs/about.md ] && cp src/docs/about.md docs/) || true | |
make mkd-gh-deploy |