Skip to content

Switch from poetry to uv (#524) #180

Switch from poetry to uv (#524)

Switch from poetry to uv (#524) #180

name: Deploy Documentation
# Controls when the action will run. Triggers the workflow on push
on:
workflow_dispatch:
push:
branches:
- master
paths:
- "src/docs/*"
- "src/sssom_schema/schema/sssom_schema.yaml"
- "mkdocs.yml"
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
build-docs:
# The type of runner that the job will run on
runs-on: ubuntu-latest
permissions:
contents: write
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
#----------------------------------------------
# check-out repo and set-up python
#----------------------------------------------
- name: Check out repository
uses: actions/checkout@v4.2.2
with:
# persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
- name: Set up Python ${{ matrix.python-version }}
run: uv python install ${{ matrix.python-version }}
- name: Install dependencies
run: uv sync --all-groups
#----------------------------------------------
# generate markdown files
#----------------------------------------------
- name: Create local docs
run: |
mkdir -p docs
touch docs/.nojekyll
make gendoc
#----------------------------------------------
# deploy website to gh-pages
#----------------------------------------------
- name: Deploy web-based documentation to GitHub Pages
run: |
make mkd-gh-deploy