Skip to content

Commit 115bd7b

Browse files
authored
docs: Fix "Bring your own toolbox" in DEVELOPING.md (vectordotdev#18014)
There were a couple of small things I ran into while getting my development environment working, and I thought I'd update the docs to reflect them: - `cargo-nextest` is neede for some of the `make` targets - `SCOPE` needs to be capitalised when running tests, or it is silently ignored
1 parent 39a2bf5 commit 115bd7b

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/DEVELOPING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ To build Vector on your own host will require a fairly complete development envi
121121
Loosely, you'll need the following:
122122

123123
- **To build Vector:** Have working Rustup, Protobuf tools, C++/C build tools (LLVM, GCC, or MSVC), Python, and Perl, `make` (the GNU one preferably), `bash`, `cmake`, `GNU coreutils`, and `autotools`.
124+
- **To run `make test`:** Install [`cargo-nextest`](https://nexte.st/)
124125
- **To run integration tests:** Have `docker` available, or a real live version of that service. (Use `AUTOSPAWN=false`)
125126
- **To run `make check-component-features`:** Have `remarshal` installed.
126127
- **To run `make check-licenses` or `cargo vdev build licenses`:** Have `rust-license-tool` [installed](https://github.com/DataDog/rust-license-tool).
@@ -141,19 +142,19 @@ cargo build
141142
make build-dev
142143
# Validate your test pass
143144
cargo test sources::example
144-
make test scope="sources::example"
145+
make test SCOPE="sources::example"
145146
# Validate tests (that do not require other services) pass
146147
cargo test
147148
make test
148149
# Validate your tests pass (starting required services in Docker)
149-
make test-integration scope="sources::example"
150+
make test-integration SCOPE="sources::example"
150151
# Validate your tests pass against a live service.
151-
make test-integration scope="sources::example" autospawn=false
152+
make test-integration SCOPE="sources::example" autospawn=false
152153
cargo test --features docker sources::example
153154
# Validate all tests pass (starting required services in Docker)
154155
make test-integration
155156
# Run your benchmarks
156-
make bench scope="transforms::example"
157+
make bench SCOPE="transforms::example"
157158
cargo bench transforms::example
158159
# Format your code before pushing!
159160
make fmt

0 commit comments

Comments
 (0)