Skip to content

Commit

Permalink
review: add DEVELOPMENT.md file.
Browse files Browse the repository at this point in the history
Signed-off-by: Piotr Sikora <[email protected]>
  • Loading branch information
PiotrSikora committed Oct 27, 2024
1 parent 2d3ff62 commit 2dc33dc
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 26 deletions.
29 changes: 29 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -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
28 changes: 2 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 2dc33dc

Please sign in to comment.