Better CI Publishing #1
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: Publish Python 🐍 distribution 📦 to PyPI | |
| on: | |
| release: | |
| types: [published] | |
| jobs: | |
| build: | |
| name: Build distribution 📦 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.x" | |
| - name: Install pypa/build | |
| run: >- | |
| python3 -m | |
| pip install | |
| build | |
| --user | |
| - name: Build a binary wheel and a source tarball | |
| run: python3 -m build | |
| - name: Store the distribution packages | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: python-package-distributions | |
| path: dist/ | |
| publish-to-pypi: | |
| name: >- | |
| Publish Python 🐍 distribution 📦 to PyPI | |
| if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes | |
| needs: | |
| - build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: release | |
| url: https://pypi.org/p/paramnormal # Replace <package-name> with your PyPI project name | |
| permissions: | |
| id-token: write # IMPORTANT: mandatory for trusted publishing | |
| steps: | |
| - name: Download all the dists | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: python-package-distributions | |
| path: dist/ | |
| - name: Publish distribution 📦 to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| ## officially, the python docs want you pushing to TestPyPI | |
| ## after every merge and to PyPI with every tag. You push the | |
| ## tag, and then this GHA would do the release. | |
| ## In practice, I don't like this. You need to alter the version | |
| ## number with every PR to get a clean upload to TestPyPI. | |
| ## | |
| ## My approach is to only upload to TestPyPI with the tag push, | |
| ## and then to upload to PyPI with the GitHub release. And so | |
| ## I've commented out this sign & release workflow | |
| # github-release: | |
| # name: >- | |
| # Sign the Python 🐍 distribution 📦 with Sigstore | |
| # and upload them to GitHub Release | |
| # needs: | |
| # - publish-to-pypi | |
| # runs-on: ubuntu-latest | |
| # permissions: | |
| # contents: write # IMPORTANT: mandatory for making GitHub Releases | |
| # id-token: write # IMPORTANT: mandatory for sigstore | |
| # steps: | |
| # - name: Download all the dists | |
| # uses: actions/download-artifact@v3 | |
| # with: | |
| # name: python-package-distributions | |
| # path: dist/ | |
| # - name: Sign the dists with Sigstore | |
| # uses: sigstore/[email protected] | |
| # with: | |
| # inputs: >- | |
| # ./dist/*.tar.gz | |
| # ./dist/*.whl | |
| # - name: Create GitHub Release | |
| # env: | |
| # GITHUB_TOKEN: ${{ github.token }} | |
| # run: >- | |
| # gh release create | |
| # '${{ github.ref_name }}' | |
| # --repo '${{ github.repository }}' | |
| # --notes "" | |
| # - name: Upload artifact signatures to GitHub Release | |
| # env: | |
| # GITHUB_TOKEN: ${{ github.token }} | |
| # # Upload to GitHub Release using the `gh` CLI. | |
| # # `dist/` contains the built packages, and the | |
| # # sigstore-produced signatures and certificates. | |
| # run: >- | |
| # gh release upload | |
| # '${{ github.ref_name }}' dist/** | |
| # --repo '${{ github.repository }}' |