Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 9 additions & 12 deletions .github/workflows/bindings-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,17 @@ name: Release language bindings
# Pushing a signed `payjoin-ffi-<version>` tag verifies the tag and the
# shared binding version, builds the native libraries once, runs every
# language's build, package and smoke checks at that commit, then
# publishes Python, JavaScript, C#, and Dart through the `release`
# environment (required reviewer) with keyless OIDC and cuts one GitHub
# release holding every package and native library.
# attests the Python wheels and publishes JavaScript, C#, and Dart
# through the `release` environment (required reviewer) with keyless
# OIDC. Alongside the publishes, it cuts one GitHub release holding
# every package and native library from the same tested build,
# independent of the registries' outcome.
#
# Each registry has its own publish job. All four wait on every language
# build, so they reach the environment gate together and one approval
# releases them all; a registry failure is retried with "Re-run failed
# jobs" on the same run, reusing the tested artifacts.
# jobs" on the same run, reusing the tested artifacts and leaving the
# GitHub release alone.

on:
push:
Expand Down Expand Up @@ -119,6 +122,7 @@ jobs:
with:
subject-path: dist/*.whl
- name: Publish to PyPI
if: false
uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
with:
packages-dir: dist
Expand Down Expand Up @@ -253,14 +257,7 @@ jobs:

github-release:
name: Create GitHub release
needs:
[
verify-tag,
publish-python,
publish-javascript,
publish-csharp,
publish-dart,
]
needs: [verify-tag, python, javascript, csharp, dart, kotlin, native]
runs-on: ubuntu-26.04
permissions:
contents: write # create the Release for this tag and upload assets
Expand Down
28 changes: 16 additions & 12 deletions payjoin-ffi/RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,22 +88,26 @@ environment, and allow `payjoin-ffi-*` in the repository's tag rules.
4. The `Release language bindings` run verifies the tag, builds and smoke
tests every language, then pauses four publish jobs on the `release`
environment. Approve the pending deployment once; it covers all four
jobs. Each registry is published with OIDC from the tested artifacts.
5. The run attaches the wheels, npm tarball, NuGet package, staged Dart
package, every native library as `payjoin_ffi-<version>-<target>.<ext>`,
and one `SHA256SUMS` covering them all to the GitHub release. The
wheels, the NuGet package and the Dart package carry those same native
libraries, byte for byte. Verify an install from each registry and
check provenance with `gh attestation verify FILE -R payjoin/rust-payjoin`.
Optionally sign `SHA256SUMS` locally and upload `SHA256SUMS.asc`; no
signing key reaches a runner.
jobs. Each registry except PyPI is published with OIDC from the
tested artifacts.
5. Once the builds pass, without waiting for the approval or the
registries, the run creates the GitHub release from the tested
artifacts. It attaches the wheels, npm tarball, NuGet package, staged
Dart package, every native library as
`payjoin_ffi-<version>-<target>.<ext>`, and one `SHA256SUMS` covering
them all. The wheels, the NuGet package and the Dart package carry
those same native libraries, byte for byte. Verify an install from
npm, NuGet and pub.dev and check provenance with
`gh attestation verify FILE -R payjoin/rust-payjoin`. Optionally sign
`SHA256SUMS` locally and upload `SHA256SUMS.asc`; no signing key
reaches a runner.

## If a publish job fails

Each registry has its own job, so use **Re-run failed jobs** on the same
run and approve the environment again. The re-run publishes from the same
tested artifacts and leaves the registries that already succeeded alone.
Never move a published tag or replace a published package; fix forward
with a new version.
tested artifacts and leaves the GitHub release and the registries that
already succeeded alone. Never move a published tag or replace a
published package; fix forward with a new version.

[automated publishing]: https://dart.dev/tools/pub/automated-publishing
Loading