You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -270,23 +270,23 @@ bun generate:sdk # Generate all SDK types and code
270
270
271
271
The [`breaking-changes`](./.github/workflows/breaking-changes.yml) workflow blocks PRs that alter any of the three protected contracts. If your change is intentional, update the relevant baseline before pushing:
272
272
273
-
| Contract | What triggers the failure | How to update |
274
-
|---|---|---|
275
-
| Proto fields | Field deleted, renamed, renumbered, or type changed | No baseline file — CI runs `buf breaking` on `submodules/chainlink-protos` (`cre` module) against the submodule commit pinned on `main`|
276
-
| TypeScript public API | An exported type/interface was removed or changed | Run `bun run update-api-baseline` inside `packages/cre-sdk` and commit `api-baseline.d.ts`|
277
-
| JS host binding names | A binding was added, removed, or renamed in `host-bindings.ts`| Run `bun test --update-snapshots` inside `packages/cre-sdk` and commit the updated `__snapshots__` file |
278
-
| Rust host imports | An `extern "C"` import was added or removed in `lib.rs`| Re-run the sed extraction (see `breaking-changes.yml`) and commit `host-imports-baseline.txt`|
273
+
| Contract | What triggers the failure | How to update|
| Proto fields | Field deleted, renamed, renumbered, or type changed| No baseline file — CI runs `buf breaking` on `submodules/chainlink-protos` (`cre` module) against the submodule commit pinned on `main`|
276
+
| TypeScript public API | An exported type/interface was removed or changed | Run `bun run update-api-baseline` inside `packages/cre-sdk` and commit `api-baseline.d.ts`|
277
+
| JS host binding names | A binding was added, removed, or renamed in `host-bindings.ts`| Run `bun test --update-snapshots` inside `packages/cre-sdk` and commit the updated `__snapshots__` file |
278
+
| Rust host imports | An `extern "C"` import was added or removed in `lib.rs`| Re-run the sed extraction (see `breaking-changes.yml`) and commit `host-imports-baseline.txt`|
279
279
280
280
#### CI override labels
281
281
282
282
When a change is **intentionally** breaking and cannot be fixed by updating a baseline (e.g. a coordinated proto break before `main` catches up), a **maintainer** adds the matching label on the PR (this re-runs the workflow):
Labels are an audit trail in the PR timeline, not a substitute for review. Prefer updating baselines (`api-baseline.d.ts`, snapshots, `host-imports-baseline.txt`) when the new contract is the new source of truth. For proto breaks, coordinate the `chainlink-protos` submodule bump and document migration notes in the PR.
0 commit comments