chore(contract): sync ocp protos to ea6418c5 and add a changelog - #4
Merged
Conversation
Adds the Balance service: ocp.balance.v1.Balance, one unary RPC GetBalance. Nothing existing changed — the other nine generated Swift files are untouched, so no enum case was renumbered and the toolchain did not move.
This was referenced Aug 26, 2026
publish.yml created the GitHub release with --generate-notes, which lists merged PR titles. For a contract package that says nothing useful: 0.1.0 released with a body that was only a "Full Changelog" link, so a consumer reading it could not tell what was in the API. Release notes now come from a CHANGELOG.md section matching the published version, written in the PR that syncs the contract while the diff is still at hand. A version with no section fails the publish, and it fails before the upload, since Maven Central will not take a version number twice.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Picks up
ocp-protobuf-api@ea6418c5— "Add the Balance RPC service (#63)".The change
One new file,
proto/balance/v1/ocp_balance_service.proto. Nothing pre-existing moved, so no message, field, or result enum was renumbered.GetBalanceRequestcarries no auth or signature field, unlike every other OCP endpoint. Both app scaffolds implement it that way rather than pattern-matching the neighbours, but if reading any owner's balance unauthenticated was not the intent, this is the moment to catch it.The generated Swift is committed alongside the proto, produced by the generators pinned in
scripts/toolchain.env. No generator version moved, so theSources/diff is only the two new Balance files.Release
Needs publishing at
0.2.0: additive API surface over0.1.0, which is the only release so far.Release notes
publish.ymlcreated the release with--generate-notes, which lists merged PR titles. That is why0.1.0released with a body containing nothing but a "Full Changelog" link: a consumer reading it cannot tell what is in the API.Notes now come from the
CHANGELOG.mdsection matching the version being published, written here in the sync PR while the contract diff is still at hand. A version with no section fails the publish, and it fails in an early step, before anything is uploaded, because Maven Central will not accept a version number twice.flipcash2-client-protocolhad the same gap and the same workflow. code-payments/flipcash2-client-protocol#4 mirrors this half, so the two publish workflows stay identical apart from names and coordinates.Both consumer PRs already pin
0.2.0and are drafts until it exists: