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

fix: remove dependency on protoc in pbjson-types #78

Closed
wants to merge 1 commit into from

Conversation

rnarubin
Copy link
Contributor

This change moves pbjson-type's code generation to a manual executable instead of build.rs. Now the generated files are checked into the repo, and users do not need protoc to build the pbjson-types crate.

This has a slight drawback in that pbjson developers will need to invoke the generator manually after any relevant code-gen changes. This should generally be a worthwhile tradeoff, as several users have encountered trouble with requiring protoc (see #62).

That drawback could potentially be averted with some CI steps to run the generator and check-in the code automatically; this change does not include such automation however.

This change moves pbjson-type's code generation to a manual executable
instead of build.rs. Now the generated files are checked into the repo,
and users do not need `protoc` to build the pbjson-types crate.

This has a slight drawback in that pbjson developers will need to invoke
the generator manually after any relevant code-gen changes. This should
generally be a worthwhile tradeoff, as several users have encountered
trouble with requiring protoc (see influxdata#62).

That drawback could potentially be averted with some CI steps to run the
generator and check-in the code automatically; this change does not
include such automation however.
@rnarubin
Copy link
Contributor Author

CI auditing doesn't like crates named generator because one has a security notice 🤷 Renamed the sub-crate to code-gen

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.

2 participants