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.

Sign up for GitHub

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

docs: document how to generate protofiles #836

Merged
merged 2 commits into from
May 2, 2023
Merged

docs: document how to generate protofiles #836

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dadfe78
docs: document how to generate protofiles
oddgrd May 2, 2023
c0e5869
docs: expand on crate description
oddgrd May 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions proto/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Shuttle-proto

This crate contains the protofiles used to generate the provisioner and runtime services,
as well as the generated code.

If you need to make changes to the protofiles, you need to run the tests for this crate to
regenerate the generated files in `proto/src/generated`. We do it like this so users don't
need protoc installed to install `cargo-shuttle`.

To run the tests and generate the files, simply run:

```bash
cargo test -p shuttle-proto
```