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

Identify breaking changes #162

Open
codeboten opened this issue Jan 20, 2025 · 0 comments
Open

Identify breaking changes #162

codeboten opened this issue Jan 20, 2025 · 0 comments

Comments

@codeboten
Copy link
Contributor

It would be great if there was automation in place to provide maintainers of the configuration repo with an indication of a breaking change. I'm not sure if there's already tooling out there to accomplish this, but the proto repository uses bufio to identify breaking changes in the proto. Maybe something like it is available for json schema?

At the very least, this issue should be used to document some guidelines in the review process for maintainers/approvers to follow. Something along the lines of:

  • when there are breaking changes to the example files, ensure the changes are documented as breaking
  • ensure file format version numbers are incremented for breaking changes
  • ...

It might be useful for this repository to include example files for the different versions of the schema, this would allow users/implementers to have this available for testing as well.

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

No branches or pull requests

1 participant