Skip to content
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.

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

Better document the configuration #818

Open
Shnatsel opened this issue Feb 25, 2023 · 0 comments · May be fixed by #942
Open

Better document the configuration #818

Shnatsel opened this issue Feb 25, 2023 · 0 comments · May be fixed by #942
Labels
cargo-audit crate Issues relating to the `cargo-audit` crate enhancement good first issue Good for newcomers

Comments

@Shnatsel
Copy link
Member

Right now 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. But this is not discoverable, leading to people complaining that the default doesn't work well for them and asking to change the defaults.

We need to better document the existence of this configuration file.

@Shnatsel Shnatsel added enhancement cargo-audit crate Issues relating to the `cargo-audit` crate good first issue Good for newcomers labels Feb 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cargo-audit crate Issues relating to the `cargo-audit` crate enhancement good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant