Skip to content

Commit 6d2e441

Browse files
authored
Merge pull request #1530 from axodotdev/cargo-auditable-docs
Add cargo-auditable docs.
2 parents 7156093 + 13a60c1 commit 6d2e441

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

book/src/reference/config.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ We're currently in the middle of [a major config migration](https://github.com/a
4141
* [`msvc-crt-static`](#msvc-crt-static)
4242
* [`precise-builds`](#precise-builds)
4343
* [`rust-toolchain-version`](#rust-toolchain-version)
44+
* [`cargo-auditable`](#cargo-auditable)
4445

4546
[installer settings](#installer-settings)
4647
* [`installers`](#installers)
@@ -590,6 +591,15 @@ The syntax must be a valid rustup toolchain like "1.60.0" or "stable" (should no
590591
591592
Without this setting, CI won't explicitly setup a toolchain, so whatever's on the machine will be used (with things like rust-toolchain.toml behaving as normal).
592593
594+
#### `cargo-auditable`
595+
596+
> <span style="float:right">since 0.26.0<br>[package-local][]</span>
597+
> default = `false`
598+
599+
Specifies whether to use [`cargo auditable`](https://github.com/rust-secure-code/cargo-auditable) to embed metadata about your dependency tree into the built executables.
600+
When this value is false, dist will run `cargo build`; when it is true, dist will run `cargo auditable build`.
601+
602+
You can then use [`cargo audit`](https://github.com/rustsec/rustsec/blob/main/cargo-audit/README.md) to audit your dependencies for security vulnerabilities that have been reported to the [RustSec Vulnerability Database](https://rustsec.org/).
593603
594604
## installer settings
595605

book/src/supplychain-security/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you have an integration you are looking for [file an issue](https://github.co
2323
## SBOMs and Dependency Managers
2424

2525
* [🔜 cargo-CycloneDX](https://github.com/axodotdev/cargo-dist/issues/1016)
26-
* [🔜 cargo-auditable](https://github.com/axodotdev/cargo-dist/issues/81)
26+
* [cargo-auditable](../reference/config.html#cargo-auditable)
2727

2828

2929
## Software identification

0 commit comments

Comments
 (0)