[DOCS] Improve documentation for Cargo audit configuration file #942
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
amousset
reviewed
Aug 27, 2023
| ``` | ||
| $ cargo audit --ignore RUSTSEC-2017-0001 | ||
| ``` | ||
|
|
||
| This option can also be configured via the [`audit.toml`](./audit.toml.example) file. | ||
|
|
||
| Cargo audit can be configured using a file called [audit.toml](./.cargo/audit.toml) This file is optional, and the default settings will work well for most people. |
There was a problem hiding this comment.
The .cargo/audit.toml file in the repository is the file used for the project itself, and is not a documentation file. Documentation (like the line above does) should point to the example file audit.toml.example.
amousset
reviewed
Aug 27, 2023
| @@ -4,6 +4,9 @@ ignore = [ | |||
| "RUSTSEC-2020-0159", # `chrono` localtime_r segfault | |||
| ] | |||
|
|
|||
| show = ["unmaintained", "unsound"] | |||
| fatal = ["critical"] | |||
There was a problem hiding this comment.
I don't see where these option names come from, the advisories config section looks like it does not include them.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #818
Description
Cargo audit provides flexible controls for which kinds of advisories are reported (e.g. show/hide unmaintained or unsound) and which are considered fatal (i.e. cause non-zero exit code, cause CI to fail) via a config file is to be located in
.cargo/audit.toml. However, this file is not discoverable, leading to people complaining that the default doesn't work well for them and asking to change the defaults.This pull request proposes to add the following to the Cargo audit documentation:
This will help users find and understand the configuration file, and make it easier for them to customize the behavior of Cargo audit.
Changes
.cargo/audit.tomlfile.