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.

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

3rd-party: include Protolock utility #5314

Merged
merged 1 commit into from
Nov 6, 2018

Conversation

nilslice
Copy link
Contributor

@nilslice nilslice commented Nov 6, 2018

protolock is a utility to help ensure no API-breaking changes are made to a set of protocol buffer definitions. This includes all native protobuf types and services + RPCs.

A list of all rules enforced by protolock include:

No Using Reserved Fields
No Removing Reserved Fields
No Removing Fields Without Reserve
No Changing Field IDs
No Changing Field Types
No Changing Field Names
No Removing RPCs
No Changing RPC Signature

Additionally, users can define their own plugins to add custom checks. protolock plugins are similar in use and creation to protoc plugins.

A more comprehensive presentation of the tool can be found here.

@acozzette acozzette merged commit eaf672f into protocolbuffers:master Nov 6, 2018
@acozzette
Copy link
Member

@nilslice Thanks for the pull request! protolock sounds like a nice tool to have.

@nilslice nilslice deleted the patch-1 branch November 6, 2018 01:19
@nilslice
Copy link
Contributor Author

nilslice commented Nov 6, 2018

Thank you! Let me know if you end up getting a chance to try it. It's saved our codebase and API consumers quite a few times 😆

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants