Release flow #2005
Workflow file for this run
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: Build Documentation | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: [main] | |
| paths: | |
| - tests/* | |
| - hydromt/* | |
| - data/* | |
| - docs/* | |
| - examples/* | |
| - pyproject.toml | |
| - .github/workflows/docs.yml | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - tests/* | |
| - hydromt/* | |
| - data/* | |
| - docs/* | |
| - examples/* | |
| - pyproject.toml | |
| - .github/workflows/docs.yml | |
| jobs: | |
| test-docs: | |
| defaults: | |
| run: | |
| shell: bash -e -l {0} | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: checkout code | |
| uses: actions/checkout@v4 | |
| - uses: prefix-dev/setup-pixi@v0.8.1 | |
| with: | |
| pixi-version: "v0.21.1" | |
| environments: full-py311 | |
| - name: Prepare pixi | |
| run: | | |
| pixi run --locked -e full-py311 install-hydromt | |
| # if we're not publishing we don't have to write them, so we might as well | |
| # save ourself a bunch of IO time | |
| - name: Generate dummy docs | |
| if: ${{ github.event_name == 'pull_request' }} | |
| run: | | |
| pixi run --locked -e full-py311 sphinx-build ./docs ./docs/_build -b dummy -W | |
| - name: Generate docs | |
| if: ${{ github.event_name != 'pull_request' }} | |
| run: | | |
| pixi run --locked -e full-py311 html | |
| echo "DOC_VERSION=$(pixi run --locked -e full-py311 python -c 'from hydromt import __version__ as v; print("dev" if "dev" in v else "v"+v.replace(".dev",""))')" >> $GITHUB_ENV | |
| - name: Upload to GitHub Pages | |
| if: ${{ github.event_name != 'pull_request' }} | |
| uses: peaceiris/actions-gh-pages@v3.9.3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/_build/html | |
| exclude_assets: .buildinfo,_sources/*,_examples/*.ipynb | |
| destination_dir: ./${{ env.DOC_VERSION }} | |
| keep_files: false | |
| full_commit_message: Deploy ${{ env.DOC_VERSION }} to GitHub Pages |