Fix Rust build and align README with available Makefile targets - #21
Open
KshitijKaushik123 wants to merge 1 commit into
Open
Fix Rust build and align README with available Makefile targets#21KshitijKaushik123 wants to merge 1 commit into
KshitijKaushik123 wants to merge 1 commit into
Conversation
- Rename rust/cargo.toml to rust/Cargo.toml so Cargo recognizes it (was causing "cargo.toml is not a Cargo.toml" error on make build-rust) - Add missing Makefile targets referenced in README: deps, generate, docker-build, docker-run-all, docker-compose-up, docker-compose-down - Update README build instructions to match actual available targets and remove references to non-existent targets (run-dev, test-coverage, grpc-test, mcp-test, health-check, sample-*) - Add Rust build/run instructions to README Closes IABTechLab#17
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
1 participant
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.
Summary
Ran into a few issues while trying to build the project from scratch following the README, figured I'd clean them up.
Cargo.toml casing
rust/cargo.tomlneeds to berust/Cargo.toml— Cargo is case-sensitive about this and refuses to recognize the manifest otherwise. Runningmake build-rustfails withcargo.toml is not a Cargo.toml. Simple rename fixes it.Missing Makefile targets
The README references several targets that don't exist in the Makefile:
deps,generate,docker-build,docker-run-all,docker-compose-up,run-dev,test-coverage,grpc-test,mcp-test,health-check, and thesample-*targets. This is confusing for anyone trying to follow the getting-started instructions.I added the straightforward ones that make sense as Makefile wrappers:
deps— runsgo mod downloadand prints a reminder about the protoc pluginsgenerate— wrapsscripts/generate.shdocker-build/docker-run-all/docker-compose-up/docker-compose-down— standard Docker workflowREADME updates
Updated the build instructions to reflect what's actually available. Removed references to non-existent targets and added a section for the Rust implementation. Replaced the testing section with actual working commands (
grpcurl,curlfor health checks) instead of referencing missing make targets.Testing
make buildsucceedsmake build-rustsucceeds after the Cargo.toml renameCloses #17