From b408daa5a72d50ee3c27fd421419c30f5d2747ce Mon Sep 17 00:00:00 2001 From: giulero Date: Tue, 3 Dec 2024 14:32:22 +0100 Subject: [PATCH] Change GitHub Actions workflow for PyPi --- .github/workflows/pypi-ci.yml | 164 +++++++++++++++++++++------------- 1 file changed, 104 insertions(+), 60 deletions(-) diff --git a/.github/workflows/pypi-ci.yml b/.github/workflows/pypi-ci.yml index d24f985..95f227f 100644 --- a/.github/workflows/pypi-ci.yml +++ b/.github/workflows/pypi-ci.yml @@ -1,4 +1,6 @@ -name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI +name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI + +# Ref: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/ on: workflow_dispatch: @@ -10,74 +12,116 @@ on: types: - published jobs: - build_wheels: - name: Build wheels [${{ matrix.os }}] - runs-on: ${{ matrix.os }} - strategy: - fail-fast: false - matrix: - python-version: - - 3.8 - os: - - ubuntu-22.04 + build: + name: Build distribution 📦 + runs-on: ubuntu-latest steps: - - uses: actions/checkout@master - - run: git fetch --prune --unshallow - - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: ${{ matrix.python-version }} + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.8" + - 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@v4 + with: + name: python-package-distributions + path: dist/ - - name: Install pypa/build - run: pip install build + publish-to-pypi: + name: >- + Publish Python 🐍 distribution 📦 to PyPI + if: github.event_name == 'release' || startsWith(github.ref, 'refs/tags/') + needs: + - build + runs-on: ubuntu-latest + environment: + name: pypi + url: https://pypi.org/p/adam-robotics + permissions: + id-token: write # IMPORTANT: mandatory for trusted publishing - - name: Build wheel and a source tarball - run: python -m build --sdist --wheel --outdir dist/ . + steps: + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Publish distribution 📦 to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 - - name: Archive artifacts - uses: actions/upload-artifact@v4 - with: - name: dist-${{ matrix.os }}-${{ matrix.arch }} - path: dist + github-release: + name: >- + Sign the Python 🐍 distribution 📦 with Sigstore + and upload them to GitHub Release + needs: + - publish-to-pypi + runs-on: ubuntu-latest - deploy_test_PyPI: - name: 📦 Deploy to TestPyPI - runs-on: ubuntu-22.04 - if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/') permissions: - id-token: write + contents: write # IMPORTANT: mandatory for making GitHub Releases + id-token: write # IMPORTANT: mandatory for sigstore + steps: - - name: Download artifacts - uses: actions/download-artifact@v4 - with: - pattern: dist-* - merge-multiple: true - path: dist + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Sign the dists with Sigstore + uses: sigstore/gh-action-sigstore-python@v3.0.0 + 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 }}' - - name: Publish distribution 📦 to Test PyPI - uses: pypa/gh-action-pypi-publish@release/v1 - with: - repository_url: https://test.pypi.org/legacy/ - skip-existing: true + publish-to-testpypi: + name: Publish Python 🐍 distribution 📦 to TestPyPI + if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/') + needs: + - build + runs-on: ubuntu-latest + + environment: + name: testpypi + url: https://test.pypi.org/p/adam-robotics - deploy_PyPI: - name: 📦 Deploy to PyPI - runs-on: ubuntu-22.04 - if: github.event_name == 'release' || startsWith(github.ref, 'refs/tags/') permissions: - id-token: write - - steps: - - name: Download artifacts - uses: actions/download-artifact@v4 - with: - pattern: dist-* - merge-multiple: true - path: dist + id-token: write # IMPORTANT: mandatory for trusted publishing - - name: Publish distribution 📦 to PyPI - uses: pypa/gh-action-pypi-publish@release/v1 - with: - skip-existing: true + steps: + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Publish distribution 📦 to TestPyPI + uses: pypa/gh-action-pypi-publish@release/v1 + with: + repository-url: https://test.pypi.org/legacy/