docs #170
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: docs | |
| on: | |
| push: | |
| tags: | |
| - 'v[0-9]+.[0-9]+.[0-9]+' | |
| - 'v[0-9]+.[0-9]+.[0-9]+a[0-9]+' | |
| - 'v[0-9]+.[0-9]+.[0-9]+b[0-9]+' | |
| - 'v[0-9]+.[0-9]+.[0-9]+rc[0-9]+' | |
| workflow_dispatch: | |
| inputs: | |
| target: | |
| description: 'Site to build and deploy' | |
| type: choice | |
| options: | |
| - dev | |
| - main | |
| - dryrun | |
| required: true | |
| default: dryrun | |
| schedule: | |
| - cron: '0 9 * * SUN' | |
| jobs: | |
| build_docs: | |
| name: Documentation | |
| runs-on: 'ubuntu-latest' | |
| timeout-minutes: 120 | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| env: | |
| MPLBACKEND: "Agg" | |
| DISPLAY: ":99.0" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: "100" | |
| - name: Fetch | |
| run: git fetch --prune --tags -f | |
| - name: Set output | |
| id: vars | |
| run: echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: install | |
| run: pip install ."[doc, examples]" | |
| - name: build docs | |
| run: sphinx-build -b html doc builtdocs | |
| - name: git status | |
| run: | | |
| git status | |
| git diff | |
| - name: Deploy dev | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: | | |
| (github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'dev') || | |
| (github.event_name == 'push' && (contains(steps.vars.outputs.tag, 'a') || contains(steps.vars.outputs.tag, 'b') || contains(steps.vars.outputs.tag, 'rc'))) | |
| with: | |
| personal_token: ${{ secrets.ACCESS_TOKEN }} | |
| external_repository: holoviz-dev/colorcet | |
| publish_dir: ./builtdocs | |
| force_orphan: true | |
| - name: Deploy main | |
| if: | | |
| (github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'main') || | |
| (github.event_name == 'push' && !(contains(steps.vars.outputs.tag, 'a') || contains(steps.vars.outputs.tag, 'b') || contains(steps.vars.outputs.tag, 'rc'))) | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./builtdocs | |
| cname: colorcet.holoviz.org | |
| force_orphan: true |