-
Notifications
You must be signed in to change notification settings - Fork 90
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
Place ttrpc
files in OUT_DIR
#483
Conversation
eb6e105
to
cd61aa8
Compare
Ensure protoc and dev tools have been installed. Run `make build` or to just generate the protos: | ||
|
||
``` | ||
cargo build -p containerd-shim-wasm --no-default-features --features generate_bindings |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it probably will make it difficult to discover where the generated files are. Could you please add some guidence on this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The actual location of OUT_DIR
is an implementation detail of cargo
.
Do they need to be discoverable?
The .proto
file is discoverable and what we should care about.
As I see it, the generated files are just an artifact.
They are not really intended for human consumption, we don't even lint them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is similiar to how rust-extension project does it as well https://github.com/containerd/rust-extensions/blob/2f0ffb98b5dcf5e5473775bcf9e49abf0ccbc9f0/crates/shim-protos/src/shim.rs#L17-L19
LGTM |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm!
It seems like this needs a rebase. |
Why would we not commit the files to the repo? |
It's generally good practice not including generated files. They are a distraction and can be confusing. There's also no benefit to having them in the repo. |
Signed-off-by: Jorge Prendes <[email protected]>
cd61aa8
to
c4535cc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
This is fine I guess. |
Lookup works fine with |
This PR places the generated
ttrpc
files inOUT_DIR
, and makes the files generation unconditional.This avoid commiting the generated files to the repo.