refactor(kafka): delegate the JSON schema generation to the project#33
Merged
yannrouillard merged 1 commit intomainfrom Mar 13, 2024
Conversation
The automatic schema generation heuristic was nice for simple cases but
has several drawbacks::
- it would not work as soon as devs are a bit more creative in their
code (uses parametrized...).
It's difficult to anticipate and we should never underestimate devs
creativity.
- if it doesn't work, devs are not really autonomous to debug in case
it doesn't work as expected in their project since the code runs in
the CI and they are less likely to look at the mix of shell script
and templated scala code used in the GitHub action.
For all these reasons, the code generation for scala now only calls a
standardized sbt target that is expected to be implemented in projects.
It will be implemented out of the box in template projects and devs are
free to change it when they use a different implementation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The automatic schema generation heuristic was nice for simple cases but has several drawbacks::
it would not work as soon as devs are a bit more creative in their code (uses parametrized...). It's difficult to anticipate and we should never underestimate devs creativity.
if it doesn't work, devs are not really autonomous to debug in case it doesn't work as expected in their project since the code runs in the CI and they are less likely to look at the mix of shell script and templated scala code used in the GitHub action.
For all these reasons, the code generation for scala now only calls a standardized sbt target that is expected to be implemented in projects. It will be implemented out of the box in template projects and devs are free to change it when they use a different implementation.