Skip to content

Commit 218467b

Browse files
committed
Add note about using the act tool to README.md.
While there, rename example and reactor jobs to their plural forms. Signed-off-by: Piotr Sikora <[email protected]>
1 parent 3f4274e commit 218467b

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

.github/workflows/rust.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ jobs:
276276
cp -p bazel/cargo/Cargo.Bazel.lock Cargo.lock
277277
cargo audit
278278
279-
example:
279+
examples:
280280
runs-on: ubuntu-latest
281281

282282
strategy:
@@ -340,7 +340,7 @@ jobs:
340340
--mode validate \
341341
-c envoy.yaml
342342
343-
reactor:
343+
reactors:
344344
runs-on: ubuntu-latest
345345

346346
strategy:
@@ -368,7 +368,7 @@ jobs:
368368
run: |
369369
curl -OL https://static.rust-lang.org/rustup/rustup-init.sh
370370
chmod +x ./rustup-init.sh
371-
./rustup-init.sh -y
371+
./rustup-init.sh -y --default-toolchain nightly
372372
rm rustup-init.sh
373373
echo "$HOME/.cargo/bin" >> $GITHUB_PATH
374374

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,29 @@
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-
## Updating dependencies
31+
## Contributing
32+
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 stable
44+
act -j nightly
45+
act -j examples --matrix example:http_auth_random
46+
47+
### Updating Bazel dependencies
3248

3349
When updating dependencies, you need to regenerate Bazel `BUILD` files to match updated `Cargo.toml`:
3450

3551
```sh
3652
bazel run //bazel/cargo:crates_vendor -- --repin all
3753
```
54+
55+
56+
[`act`]: https://github.com/nektos/act

0 commit comments

Comments
 (0)