Update development setup and CI workflows #36
This file contains hidden or 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: | |
| branches: | |
| - main | |
| tags: | |
| - "*" | |
| pull_request: | |
| branches: | |
| - main | |
| merge_group: | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | |
| cancel-in-progress: true | |
| jobs: | |
| # detect whether any doc changes are included in this PR | |
| changes: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pull-requests: read | |
| outputs: | |
| docs: ${{ steps.filter.outputs.docs }} | |
| steps: | |
| - name: Checkout Source | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| if: github.event_name != 'pull_request' | |
| - name: Filter Changes | |
| uses: dorny/paths-filter@v3 | |
| id: filter | |
| with: | |
| filters: | | |
| docs: | |
| - 'docs/**' | |
| - 'conda_self/**' | |
| - '*.py' | |
| - 'environment-docs.yml' | |
| - 'pyproject.toml' | |
| - '.github/workflows/docs.yml' | |
| docs: | |
| # only run docs build if there are relevant changes | |
| needs: changes | |
| if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/') || needs.changes.outputs.docs == 'true' | |
| runs-on: ubuntu-latest | |
| env: | |
| CONDA_PKGS_DIR: ~/conda_pkgs_dir | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| steps: | |
| - name: Checkout Source | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| with: | |
| fetch-depth: 0 | |
| - name: Hash + Timestamp | |
| run: echo "HASH=${{ runner.os }}-${{ runner.arch }}-docs-$(date -u "+%Y%m")" >> $GITHUB_ENV | |
| - name: Cache Conda | |
| uses: actions/cache@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: ${{ env.CONDA_PKGS_DIR }} | |
| key: cache-docs-${{ env.HASH }} | |
| - name: Setup Miniconda | |
| uses: conda-incubator/setup-miniconda@v3 | |
| with: | |
| environment-file: environment-docs.yml | |
| activate-environment: conda-self-docs | |
| pkgs-dirs: ${{ env.CONDA_PKGS_DIR }} | |
| - name: Display conda info | |
| run: | | |
| conda info | |
| conda list | |
| python -c "import conda_self; print(f'conda-self version: {conda_self.__version__}')" | |
| - name: Build docs | |
| run: | | |
| cd docs | |
| python -m sphinx.cmd.build -M dirhtml . _build | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0 | |
| with: | |
| path: 'docs/_build/dirhtml' | |
| pages: | |
| runs-on: ubuntu-latest | |
| if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') | |
| needs: [docs] | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 | |
| # required check for docs | |
| analyze: | |
| needs: [docs, pages] | |
| if: '!cancelled()' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Determine Success | |
| uses: re-actors/alls-green@v1 | |
| with: | |
| # permit jobs to be skipped if there are no relevant changes or deployment conditions aren't met | |
| allowed-skips: ${{ toJSON(needs) }} | |
| jobs: ${{ toJSON(needs) }} |