diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..7148da8 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,29 @@ +# Development + +## Testing + +GitHub Actions can be executed locally using the [`act`] tool. + +All tests can be executed using: + + act + +Individual tests can be executed using `-j` and `--matrix` parameters, e.g.: + + act -j bazel + act -j stable + act -j nightly + act -j examples --matrix example:http_auth_random + +## Updating Bazel dependencies + +When adding and/or updating Cargo dependencies, the existing Bazel `BUILD` files +must be regenerated to match the updated `Cargo.toml`: + +```sh +bazelisk run //bazel/cargo:crates_vendor -- --repin all +``` + + +[`act`]: https://github.com/nektos/act +[`bazelisk`]: https://github.com/bazelbuild/bazelisk diff --git a/README.md b/README.md index 2eca8ec..7db3cdc 100644 --- a/README.md +++ b/README.md @@ -28,30 +28,6 @@ - [Extending Envoy with WASM and Rust](https://antweiss.com/blog/extending-envoy-with-wasm-and-rust/) - [Writing Envoy filters in Rust with WebAssembly](https://content.red-badger.com/resources/extending-istio-with-rust-and-webassembly) -## Development +## Contributing changes -### Testing - -GitHub Actions can be executed locally using the [`act`] tool. - -All tests can be executed using: - - act - -Individual tests can be executed using `-j` and `--matrix` parameters, e.g.: - - act -j bazel - act -j stable - act -j nightly - act -j examples --matrix example:http_auth_random - -### Updating Bazel dependencies - -When updating dependencies, you need to regenerate Bazel `BUILD` files to match updated `Cargo.toml`: - -```sh -bazel run //bazel/cargo:crates_vendor -- --repin all -``` - - -[`act`]: https://github.com/nektos/act +See [CONTRIBUTING.md](./CONTRIBUTING.md) and [DEVELOPMENT.md](./DEVELOPMENT.md) files.