Skip to content

Use buf to detect for wire breaking changes#415

Merged
arminru merged 3 commits intoopen-telemetry:mainfrom
aabmass:buf-breaking
Aug 3, 2022
Merged

Use buf to detect for wire breaking changes#415
arminru merged 3 commits intoopen-telemetry:mainfrom
aabmass:buf-breaking

Conversation

@aabmass
Copy link
Copy Markdown
Member

@aabmass aabmass commented Jul 28, 2022

Use Buf breaking to check PRs for wire and json breaking changes. Here is an example PR showing this in action. There was some interest for this in #400 (comment).

The config can be tweaked to add/remove specific rules if this is too noisy, see https://docs.buf.build/breaking/configuration.

@aabmass aabmass requested a review from a team July 28, 2022 20:46
Copy link
Copy Markdown
Member

@tigrannajaryan tigrannajaryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, this is very useful.

Comment thread Makefile Outdated
Comment thread .github/workflows/build-check.yaml Outdated
Comment thread buf.yaml Outdated
git remote set-branches origin '*'
git fetch --depth=1 origin main
git branch main origin/main
- name: Run make breaking-change with json output to annotate PR
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that this is very helpful, thank you!

It would be nice if you could add a breaking change in a new (dummy) PR based off this branch to illustrate how this would work.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thank you!

Comment thread Makefile
@arminru arminru merged commit 0bfcf1c into open-telemetry:main Aug 3, 2022
@aabmass aabmass deleted the buf-breaking branch August 3, 2022 13:25
bogdandrutu added a commit that referenced this pull request Aug 3, 2022
…#419)

* Use buf to detect for wire breaking changes (#415)

* Make it possible to indicate partial success in an OTLP export response [2] (#414)

* Make it possible to indicate partial success in an OTLP export response

* Update changelog with PR number

* PR suggestions

* Improve docs around using rejected as 0 to convey warnings

* Adapt comments to match recent spec wording changes

* Clarify behavior of partial success not set/empty

Co-authored-by: Aaron Abbott <aaronabbott@google.com>
Co-authored-by: Joao Grassi <joao@joaograssi.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants