Skip to content

docs(sdk): mirror CONNECTOR_RELEASE_CONTRACT.md polish patches (connector#68 sibling) #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ALLiDoizCode merged 1 commit into from
May 9, 2026
Merged

docs(sdk): mirror CONNECTOR_RELEASE_CONTRACT.md polish patches (connector#68 sibling) #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 9 additions & 7 deletions packages/sdk/CONNECTOR_RELEASE_CONTRACT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Each release publishes two artifacts:
| Artifact | Location | Architectures |
| --------------- | -------------------------------------------------------------- | ------------------------------------------------------------------ |
| npm package | `@toon-protocol/connector` on npmjs.com | n/a (pure JS) |
| Container image | `ghcr.io/toon-protocol/connector` on GitHub Container Registry | `linux/amd64`, `linux/arm64` (from the first release after PR #62) |
| Container image | `ghcr.io/toon-protocol/connector` on GitHub Container Registry | `linux/amd64`, `linux/arm64` (from the first release after PR #63) |

Releases are cut by [semantic-release](https://github.com/semantic-release/semantic-release)
on every push to `main`, when the conventional-commit history warrants a version
Expand Down Expand Up @@ -69,7 +69,7 @@ townhouse migration cycle and a CONNECTOR_MIGRATION.md row.

## Supply-chain signing

Starting from the first release after PR [#66](https://github.com/toon-protocol/connector/pull/66), every connector and ATOR sidecar image is cosign-signed via **keyless OIDC** — no static keys, no secrets beyond the default `GITHUB_TOKEN`.
Starting from `v3.6.0` (cut after PR [#66](https://github.com/toon-protocol/connector/pull/66) merged), every connector and ATOR sidecar image is cosign-signed via **keyless OIDC** — no static keys, no secrets beyond the default `GITHUB_TOKEN`.

### Verifying a release image

Expand Down Expand Up @@ -128,7 +128,7 @@ learn about new connector releases via:
not expose.
2. **`gh` CLI subscription** — fallback: subscribes to all repository events
(not releases-only):
```
```bash
gh api -X PUT /repos/toon-protocol/connector/subscription \
-f subscribed=true -f ignored=false
```
Expand Down Expand Up @@ -181,7 +181,7 @@ guarantees in [Stability guarantees](#stability-guarantees) apply.

## Verification

Two mechanisms guard against future tag-vs-content drift:
Three mechanisms guard against future tag-vs-content drift:

1. **Pre-publish (issue [#61](https://github.com/toon-protocol/connector/issues/61) /
PR [#60](https://github.com/toon-protocol/connector/pull/60)):** the
Expand All @@ -193,14 +193,15 @@ Two mechanisms guard against future tag-vs-content drift:
manifest with `docker buildx imagetools inspect` and asserts that
`org.opencontainers.image.version` equals the tag. Any mismatch fails the
workflow run.

3. **Town mirror drift detection:** The doc body is mirrored at
`packages/sdk/CONNECTOR_RELEASE_CONTRACT.md` in `toon-protocol/town`.
The town copy prepends a 3-line comment header; verify body equivalence with:
The town copy prepends a 3-line comment header; verify body equivalence
from the `toon-protocol/connector` repo root (with `toon-protocol/town`
cloned alongside as a sibling directory, e.g. `../town`):

```bash
diff CONNECTOR_RELEASE_CONTRACT.md \
<(tail -n +4 /path/to/town/packages/sdk/CONNECTOR_RELEASE_CONTRACT.md)
<(tail -n +4 ../town/packages/sdk/CONNECTOR_RELEASE_CONTRACT.md)
```

Expected output: empty. Any diff is a drift defect — open a follow-up PR in
Expand All @@ -216,3 +217,4 @@ Two mechanisms guard against future tag-vs-content drift:
`npm-release` fix for the same class of bug
- [PR #66 — cosign keyless OIDC signing](https://github.com/toon-protocol/connector/pull/66) (Story 44.3)
- Townhouse Story 44.4 — downstream consumer-facing release contract
- [Interledger Protocol V4 (RFC 0027)](https://github.com/interledger/rfcs/blob/master/0027-interledger-protocol-4/0027-interledger-protocol-4.md) — defines the ILP packet wire format referenced by the MAJOR-bump rule in [API stability](#api-stability)
Loading