Skip to content

[DOCS] Improve documentation for Cargo audit configuration file #942

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
p21nc3 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[DOCS] Improve documentation for Cargo audit configuration file #942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9bbc52b
ADD unmaintained/unsound
p21nc3 Aug 14, 2023
23568de
ADD "critical" -> audit.toml
p21nc3 Aug 14, 2023
ecf297e
cargo audit docs
p21nc3 Aug 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .cargo/audit.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ ignore = [
"RUSTSEC-2020-0159", # `chrono` localtime_r segfault
]

show = ["unmaintained", "unsound"]
fatal = ["critical"]
Copy link
Member

@amousset amousset Aug 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see where these option names come from, the advisories config section looks like it does not include them.


[output]
quiet = false
deny = ["warnings"]
3 changes: 3 additions & 0 deletions cargo-audit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,12 +97,15 @@ But there may be situations where an upgrade isn't available and the advisory do

In these cases, you can ignore advisories using the `--ignore` option.


```
$ 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.
Copy link
Member

@amousset amousset Aug 27, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


## Using `cargo audit` on Travis CI

To automatically run `cargo audit` on every build in Travis CI, you can add the following to your `.travis.yml`:
Expand Down