v3.3.0 #62
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: Release | |
| on: | |
| release: | |
| types: | |
| - published | |
| permissions: # added using https://github.com/step-security/secure-workflows | |
| contents: read | |
| jobs: | |
| build: | |
| name: Build and sign artifacts | |
| runs-on: ubuntu-latest | |
| permissions: | |
| id-token: write | |
| outputs: | |
| hashes: ${{ steps.hash.outputs.hashes }} | |
| steps: | |
| - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| - uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0 | |
| with: | |
| # NOTE: We intentionally don't use a cache in the release step, | |
| # to reduce the risk of cache poisoning. | |
| python-version: "3.x" | |
| - name: deps | |
| run: python -m pip install -U build | |
| - name: build | |
| run: python -m build | |
| - name: sign | |
| run: | | |
| mkdir -p smoketest-artifacts | |
| # we smoke-test sigstore by installing each of the distributions | |
| # we've built in a fresh environment and using each to sign and | |
| # verify for itself, using the ambient OIDC identity | |
| for dist in dist/*; do | |
| dist_base="$(basename "${dist}")" | |
| python -m venv smoketest-env | |
| ./smoketest-env/bin/python -m pip install "${dist}" | |
| # NOTE: signing artifacts currently go in a separate directory, | |
| # to avoid confusing the package uploader (which otherwise tries | |
| # to upload them to PyPI and fails). Future versions of twine | |
| # and the gh-action-pypi-publish action should support these artifacts. | |
| ./smoketest-env/bin/python -m \ | |
| sigstore sign "${dist}" \ | |
| --output-signature smoketest-artifacts/"${dist_base}.sig" \ | |
| --output-certificate smoketest-artifacts/"${dist_base}.crt" \ | |
| --bundle smoketest-artifacts/"${dist_base}.sigstore" | |
| # Verify using `.sig` `.crt` pair; | |
| ./smoketest-env/bin/python -m \ | |
| sigstore verify identity "${dist}" \ | |
| --signature "smoketest-artifacts/${dist_base}.sig" \ | |
| --cert "smoketest-artifacts/${dist_base}.crt" \ | |
| --cert-oidc-issuer https://token.actions.githubusercontent.com \ | |
| --cert-identity ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/.github/workflows/release.yml@${GITHUB_REF} | |
| # Verify using `.sigstore` bundle; | |
| ./smoketest-env/bin/python -m \ | |
| sigstore verify identity "${dist}" \ | |
| --bundle "smoketest-artifacts/${dist_base}.sigstore" \ | |
| --cert-oidc-issuer https://token.actions.githubusercontent.com \ | |
| --cert-identity ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/.github/workflows/release.yml@${GITHUB_REF} | |
| rm -rf smoketest-env | |
| done | |
| - name: Generate hashes for provenance | |
| shell: bash | |
| id: hash | |
| run: | | |
| # sha256sum generates sha256 hash for all artifacts. | |
| # base64 -w0 encodes to base64 and outputs on a single line. | |
| # sha256sum artifact1 artifact2 ... | base64 -w0 | |
| echo "hashes=$(sha256sum ./dist/* | base64 -w0)" >> $GITHUB_OUTPUT | |
| - name: Upload built packages | |
| uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0 | |
| with: | |
| name: built-packages | |
| path: ./dist/ | |
| if-no-files-found: warn | |
| - name: Upload smoketest-artifacts | |
| uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0 | |
| with: | |
| name: smoketest-artifacts | |
| path: smoketest-artifacts/ | |
| if-no-files-found: warn | |
| generate-provenance: | |
| needs: [build] | |
| name: Generate build provenance | |
| permissions: | |
| actions: read # To read the workflow path. | |
| id-token: write # To sign the provenance. | |
| contents: write # To add assets to a release. | |
| # Currently this action needs to be referred by tag. More details at: | |
| # https://github.com/slsa-framework/slsa-github-generator#verification-of-provenance | |
| uses: slsa-framework/slsa-github-generator/.github/workflows/[email protected] | |
| with: | |
| provenance-name: provenance-sigstore-${{ github.event.release.tag_name }}.intoto.jsonl | |
| base64-subjects: "${{ needs.build.outputs.hashes }}" | |
| upload-assets: true | |
| release-pypi: | |
| needs: [build, generate-provenance] | |
| runs-on: ubuntu-latest | |
| permissions: | |
| # Used to authenticate to PyPI via OIDC. | |
| id-token: write | |
| steps: | |
| - name: Download artifacts directories # goes to current working directory | |
| uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 | |
| - name: publish | |
| uses: pypa/gh-action-pypi-publish@0ab0b79471669eb3a4d647e625009c62f9f3b241 # v1.10.1 | |
| with: | |
| packages-dir: built-packages/ | |
| release-github: | |
| needs: [build, generate-provenance] | |
| runs-on: ubuntu-latest | |
| permissions: | |
| # Needed to upload release assets. | |
| contents: write | |
| steps: | |
| - name: Download artifacts directories # goes to current working directory | |
| uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 | |
| - name: Upload artifacts to github | |
| # Confusingly, this action also supports updating releases, not | |
| # just creating them. This is what we want here, since we've manually | |
| # created the release that triggered the action. | |
| uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191 # v2.0.8 | |
| with: | |
| # smoketest-artifacts/ contains the signatures and certificates. | |
| files: | | |
| built-packages/* | |
| smoketest-artifacts/* | |
| # Trigger workflow to generate pinned requirements.txt. | |
| pin-requirements: | |
| permissions: | |
| # Needed to create branch and pull request. | |
| pull-requests: write | |
| contents: write | |
| # Workflow depends on uploaded release assets. | |
| needs: [release-github] | |
| # Only trigger workflow on full releases. | |
| if: ${{ !github.event.release.prerelease }} | |
| uses: ./.github/workflows/pin-requirements.yml | |
| with: | |
| tag: ${{ github.ref_name }} |