Skip to content

Commit 0c89c7d

Browse files
authored
Remove worker heartbeat buf exception, add process to README (#636)
_**READ BEFORE MERGING:** All PRs require approval by both Server AND SDK teams before merging! This is why the number of required approvals is "2" and not "1"--two reviewers from the same team is NOT sufficient. If your PR is not approved by someone in BOTH teams, it may be summarily reverted._ <!-- Describe what has changed in this PR --> **What changed?** Remove the exception added in #633, add to README explaining this breaking change process <!-- Tell your future self why have you made these changes --> **Why?** keep things working <!-- Are there any breaking changes on binary or code level? --> **Breaking changes** <!-- If this breaks the Server, please provide the Server PR to merge right after this PR was merged. --> **Server PR**
1 parent 37b0602 commit 0c89c7d

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ Install as git submodule to the project.
1010

1111
Make your change to the temporal/proto files, and run `make` to update the openapi definitions.
1212

13+
## Breaking changes
14+
15+
Sometimes during initial feature development, there will be breaking API changes made. Running `make` will
16+
catch these changes and fail CI. If the breaking change is for a feature not yet released, a temporary `ignore`
17+
line can be added to `buf.yaml` to pass CI. This is
18+
[an example](https://github.com/temporalio/api/pull/608/files#diff-1a5ba9cba93e971f532139f694d7da802776bfe578e3f753b9c3f25968dbf42dL16)
19+
of adding such an exception. A subsequent PR will be needed to then disable to exception once it's been merged in.
20+
1321
## License
1422

1523
MIT License, please see [LICENSE](LICENSE) for details.

buf.yaml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@ breaking:
1313
- WIRE_JSON
1414
ignore:
1515
- google
16-
# TODO (yuandrew): remove this. Added for "heartbeat" changes
17-
- temporal/api/workflowservice/v1/request_response.proto
18-
- temporal/api/worker/v1/message.proto
1916
lint:
2017
use:
2118
- DEFAULT

0 commit comments

Comments
 (0)