Skip to content

Commit 2dc33dc

Browse files
committed
review: add DEVELOPMENT.md file.
Signed-off-by: Piotr Sikora <[email protected]>
1 parent 2d3ff62 commit 2dc33dc

File tree

2 files changed

+31
-26
lines changed

2 files changed

+31
-26
lines changed

DEVELOPMENT.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Development
2+
3+
## Testing
4+
5+
GitHub Actions can be executed locally using the [`act`] tool.
6+
7+
All tests can be executed using:
8+
9+
act
10+
11+
Individual tests can be executed using `-j` and `--matrix` parameters, e.g.:
12+
13+
act -j bazel
14+
act -j stable
15+
act -j nightly
16+
act -j examples --matrix example:http_auth_random
17+
18+
## Updating Bazel dependencies
19+
20+
When adding and/or updating Cargo dependencies, the existing Bazel `BUILD` files
21+
must be regenerated to match the updated `Cargo.toml`:
22+
23+
```sh
24+
bazelisk run //bazel/cargo:crates_vendor -- --repin all
25+
```
26+
27+
28+
[`act`]: https://github.com/nektos/act
29+
[`bazelisk`]: https://github.com/bazelbuild/bazelisk

README.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -28,30 +28,6 @@
2828
- [Extending Envoy with WASM and Rust](https://antweiss.com/blog/extending-envoy-with-wasm-and-rust/)
2929
- [Writing Envoy filters in Rust with WebAssembly](https://content.red-badger.com/resources/extending-istio-with-rust-and-webassembly)
3030

31-
## Development
31+
## Contributing changes
3232

33-
### Testing
34-
35-
GitHub Actions can be executed locally using the [`act`] tool.
36-
37-
All tests can be executed using:
38-
39-
act
40-
41-
Individual tests can be executed using `-j` and `--matrix` parameters, e.g.:
42-
43-
act -j bazel
44-
act -j stable
45-
act -j nightly
46-
act -j examples --matrix example:http_auth_random
47-
48-
### Updating Bazel dependencies
49-
50-
When updating dependencies, you need to regenerate Bazel `BUILD` files to match updated `Cargo.toml`:
51-
52-
```sh
53-
bazel run //bazel/cargo:crates_vendor -- --repin all
54-
```
55-
56-
57-
[`act`]: https://github.com/nektos/act
33+
See [CONTRIBUTING.md](./CONTRIBUTING.md) and [DEVELOPMENT.md](./DEVELOPMENT.md) files.

0 commit comments

Comments
 (0)