add a publish job that upload to pypi/testpypi of a version tag #337
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: Test | |
| on: [push, pull_request] | |
| jobs: | |
| check-tag: | |
| # Run on external PRs, but not on internal PRs, to avoid duplicate runs | |
| if: | | |
| github.event_name == 'push' || | |
| github.event.pull_request.head.repo.full_name != github.repository | |
| runs-on: ubuntu-latest | |
| outputs: | |
| publish_url: ${{ steps.check-publish.outputs.publish_url }} | |
| steps: | |
| - name: Check if this is a release/prerelease | |
| id: check-publish | |
| run: | | |
| tag_name="${GITHUB_REF#refs/tags/}" | |
| if [[ "$tag_name" =~ ^v[0-9]+\.[0-9]+\.[0-9]+[ab][0-9]+$ ]]; then | |
| publish_url="https://test.pypi.org/legacy/" | |
| elif [[ "$tag_name" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then | |
| publish_url="https://upload.pypi.org/legacy/" | |
| else | |
| publish_url="none" | |
| fi | |
| echo "publish_url=$publish_url" >> "$GITHUB_OUTPUT" | |
| echo "tag_name=$tag_name" | |
| echo "publish_url=$publish_url" | |
| build-sdist: | |
| name: Build source distribution | |
| needs: check-tag | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Build sdist | |
| run: pipx run build --sdist | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: build-sdist | |
| path: ${{ github.workspace }}/dist/*.tar.gz | |
| test-with-pip: | |
| name: Test with pip | |
| needs: build-sdist | |
| runs-on: ${{ matrix.os }} | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| python-version: ["3.10", "3.11", "3.12"] | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Use Python ${{ matrix.python-version}} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| pattern: "build-*" | |
| merge-multiple: true | |
| path: ${{ github.workspace }}/dist | |
| - name: Test package | |
| run: | | |
| pip install nox | |
| nox --verbose --force-python=${{ matrix.python-version }} -s test-with-pip -- dist/*.tar.gz | |
| test-with-conda: | |
| name: Test with conda | |
| needs: build-sdist | |
| runs-on: ${{ matrix.os }} | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| python-version: ["3.10", "3.11", "3.12"] | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: conda-incubator/setup-miniconda@v3 | |
| with: | |
| auto-update-conda: true | |
| python-version: ${{ matrix.python-version }} | |
| channels: conda-forge | |
| channel-priority: true | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| pattern: "build-*" | |
| merge-multiple: true | |
| path: ${{ github.workspace }}/dist | |
| - name: Show conda installation info | |
| run: | | |
| conda list | |
| conda info | |
| - name: Test package | |
| run: | | |
| pip install nox | |
| nox --verbose --force-python=${{ matrix.python-version }} -s test-with-conda -- dist/*.tar.gz | |
| build-docs: | |
| name: Build the docs | |
| needs: check-tag | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Use Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| - name: Build documentation | |
| run: | | |
| pip install nox | |
| nox -s docs | |
| publish: | |
| needs: | |
| - check-tag | |
| - test-with-pip | |
| - test-with-conda | |
| - build-docs | |
| name: "Publish to PyPI/TestPyPI" | |
| runs-on: ubuntu-latest | |
| permissions: | |
| id-token: write | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| pattern: "build-*" | |
| merge-multiple: true | |
| path: ${{ github.workspace }}/dist | |
| - uses: pypa/gh-action-pypi-publish@release/v1 | |
| if: ${{ startsWith(needs.check-tag.outputs.publish_url, 'http') }} | |
| with: | |
| repository-url: ${{ needs.check-tag.outputs.publish_url }} | |
| skip-existing: true | |
| print-hash: true | |
| verify-metadata: false |