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

docs: updates outdated Rust dynamic_modules README #38405

Merged
merged 1 commit into from
Feb 11, 2025
Merged
Changes from all commits
Commits
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
10 changes: 4 additions & 6 deletions source/extensions/dynamic_modules/sdk/rust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ Note that this crate references the local ABI header files, so this is intended
```
[dependencies]
envoy-proxy-dynamic-modules-rust-sdk = { git = "https://github.com/envoyproxy/envoy", tag = "vX.Y.Z" }

[dev-dependencies.envoy-proxy-dynamic-modules-rust-sdk]
git = "https://github.com/envoyproxy/envoy"
tag = "vX.Y.Z"
# Enable testing features to use the mock Envoy objects.
features = ["testing"]
Comment on lines -9 to -14
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a garbage left during the iteration in a previous PR - no longer valid

# Or, you can use a specific commit instead of a tag:
# envoy-proxy-dynamic-modules-rust-sdk = { git = "https://github.com/envoyproxy/envoy", rev = "abcdef" }
```

instead of `envoy-proxy-dynamic-modules-rust-sdk = "X.Y.Z"`.

See [Examples](https://github.com/envoyproxy/dynamic-modules-examples) for more details on how to use this SDK.