Skip to content

Commit

Permalink
chore(dev): Install dd-rust-license-tool from crates.io (#18025)
Browse files Browse the repository at this point in the history
And update vdev as well as the docs to use the new binary name.

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
  • Loading branch information
jszwedko authored Jul 19, 2023
1 parent b00727e commit 7d0db6b
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ When deprecating functionality in Vector, see [DEPRECATION.md](DEPRECATION.md).

When adding, modifying, or removing a dependency in Vector you may find that you need to update the
inventory of third-party licenses maintained in `LICENSE-3rdparty.csv`. This file is generated using
[rust-license-tool](https://github.com/DataDog/rust-license-tool.git) and can be updated using
[dd-rust-license-tool](https://github.com/DataDog/rust-license-tool.git) and can be updated using
`cargo vdev build licenses`.

## Next steps
Expand Down
2 changes: 1 addition & 1 deletion docs/DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Loosely, you'll need the following:
- **To run `make test`:** Install [`cargo-nextest`](https://nexte.st/)
- **To run integration tests:** Have `docker` available, or a real live version of that service. (Use `AUTOSPAWN=false`)
- **To run `make check-component-features`:** Have `remarshal` installed.
- **To run `make check-licenses` or `cargo vdev build licenses`:** Have `rust-license-tool` [installed](https://github.com/DataDog/rust-license-tool).
- **To run `make check-licenses` or `cargo vdev build licenses`:** Have `dd-rust-license-tool` [installed](https://github.com/DataDog/rust-license-tool).
- **To run `cargo vdev build component-docs`:** Have `cue` [installed](https://cuelang.org/docs/install/).

If you find yourself needing to run something inside the Docker environment described above, that's totally fine, they won't collide or hurt each other. In this case, you'd just run `make environment-generate`.
Expand Down
4 changes: 2 additions & 2 deletions scripts/environment/prepare.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ fi
if ! cargo deny --version >& /dev/null ; then
rustup run stable cargo install cargo-deny --force --locked
fi
if ! rust-license-tool --help >& /dev/null ; then
cargo install --git https://github.com/DataDog/rust-license-tool
if ! dd-rust-license-tool --help >& /dev/null ; then
rustup run stable cargo install dd-rust-license-tool --version 1.0.1 --force --locked
fi

# Currently fixing this to version 0.30 since version 0.31 has introduced
Expand Down
2 changes: 1 addition & 1 deletion vdev/src/commands/build/licenses.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ pub struct Cli {}

impl Cli {
pub fn exec(self) -> Result<()> {
app::exec("rust-license-tool", ["write"], true)
app::exec("dd-rust-license-tool", ["write"], true)
}
}
2 changes: 1 addition & 1 deletion vdev/src/commands/check/licenses.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ pub struct Cli {}

impl Cli {
pub fn exec(self) -> Result<()> {
app::exec("rust-license-tool", ["check"], true).map_err(|err| {
app::exec("dd-rust-license-tool", ["check"], true).map_err(|err| {
info!("Run `cargo vdev build licenses` to regenerate the file");
err
})
Expand Down

0 comments on commit 7d0db6b

Please sign in to comment.