Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Consider adding a backward compatibility checker for gRPC APIs #466

Open
alexhamel opened this issue Aug 23, 2024 · 0 comments
Open

Consider adding a backward compatibility checker for gRPC APIs #466

alexhamel opened this issue Aug 23, 2024 · 0 comments

Comments

@alexhamel
Copy link

Proposal includes:
• Add a new 'break' or 'compat' target in each gRPC API's Makefile
• Have the new target invoke the 'buf breaking' tool (https://buf.build/docs/breaking/overview)
• Have a rolling check against the 'main' branch of the repository or check against a previous release/git tag
• Do not enforce the 'compat' check for now. It could easily be enforced later on. Either at build time or in CI/CD.
alexhamel added a commit to alexhamel/opi-api that referenced this issue Aug 23, 2024
@alexhamel
chore: add backward compatibility checker
9f61723 
Editing Makefiles across folders to:
- Add new target that runs 'buf breaking' check
- Edit the buf.yaml configuration file to remove googleapis files from
the list of files scanned by the tool

Fixes: opiproject#466
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alexhamel