Skip to content

Commit

Permalink
Add note about using the act tool to README.md.
Browse files Browse the repository at this point in the history
While there, rename example and reactor jobs to their plural forms.

Signed-off-by: Piotr Sikora <[email protected]>
  • Loading branch information
PiotrSikora committed Oct 25, 2024
1 parent 3f4274e commit 218467b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ jobs:
cp -p bazel/cargo/Cargo.Bazel.lock Cargo.lock
cargo audit
example:
examples:
runs-on: ubuntu-latest

strategy:
Expand Down Expand Up @@ -340,7 +340,7 @@ jobs:
--mode validate \
-c envoy.yaml
reactor:
reactors:
runs-on: ubuntu-latest

strategy:
Expand Down Expand Up @@ -368,7 +368,7 @@ jobs:
run: |
curl -OL https://static.rust-lang.org/rustup/rustup-init.sh
chmod +x ./rustup-init.sh
./rustup-init.sh -y
./rustup-init.sh -y --default-toolchain nightly
rm rustup-init.sh
echo "$HOME/.cargo/bin" >> $GITHUB_PATH
Expand Down
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,29 @@
- [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)

## Updating dependencies
## Contributing

### 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 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

0 comments on commit 218467b

Please sign in to comment.