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
+22Lines changed: 22 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -206,6 +206,28 @@ See the [monitoring & logging](docs/monitoring.md) documentation from more infor
206
206
207
207
Consult the [server API documentation](pkg/server/README.md) to get started.
208
208
209
+
## CI / Workflows
210
+
211
+
### Contract Testing Escape Hatch
212
+
213
+
The `ConsumerContractTests` and `CanIDeploy` jobs run on every PR to validate Pact consumer contracts against the broker.
214
+
215
+
In an emergency (e.g. hotfix where contracts need updating but can't block the merge), these jobs can be bypassed by applying the **`skip-contract-tests`** label to the PR.
216
+
217
+
| Scenario | ConsumerContractTests | CanIDeploy |
218
+
|---|---|---|
219
+
| Normal PR (no label) | runs | runs |
220
+
| PR with `skip-contract-tests` label | skipped | skipped |
221
+
222
+
Skipped jobs show as neutral (green) in GitHub, satisfying required status checks. The label is auditable — GitHub records who added it and when.
223
+
224
+
**The label must be created once in repo settings:**
225
+
- Name: `skip-contract-tests`
226
+
- Color: `#e11d48`(red — visually alarming to discourage casual use)
227
+
- Description: `Emergency: bypass pact contract tests. Use only when tests need updating but can't block a hotfix.`
228
+
229
+
The workflow also triggers on the `labeled` event, so adding the label to an existing PR immediately re-runs the workflow with the jobs skipped (no need to push a new commit).
230
+
209
231
## Development
210
232
211
233
Consult the [developer documentation](DEVELOPER.md) for local development instructions.
0 commit comments