Skip to content

Conversation

@SupernaviX
Copy link
Collaborator

@SupernaviX SupernaviX commented Nov 7, 2025

Pull Request Title

Enable cargo audit in CI

Description

Run cargo audit as part of the suite of tests required to merge a PR. This is a tool which detects when the project depends on crates with reported vulnerabilities. The typical fix is to update those vulnerable crates (manually or by running cargo update)

Related Issue(s)

Contributes to #260

How was this tested?

This very PR is green (and I checked, the audit was run

Checklist

  • My code builds and passes local tests
  • I added/updated tests for my changes, where applicable
  • I updated documentation (if applicable)
  • CI is green for this PR

Impact / Side effects

This can potentially disrupt development, by preventing merges if a vulnerability is reported in a crate. If that happens, we need to fix the vulnerability immediately, or add it to the ignore list. I've disabled "informational" warnings (about e.g. unmaintained crates) to make sure this only happens for legit issues.

Reviewer notes / Areas to focus

@SupernaviX SupernaviX marked this pull request as ready for review November 7, 2025 21:37
@lowhung lowhung self-requested a review November 8, 2025 01:43
run: cargo clippy --all-targets --all-features -- -D warnings

- name: Run Audit
uses: rustsec/[email protected]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we run this only when Cargo.toml or Cargo.lock files are changed for efficiency?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No, because vulnerabilities in crates we already use can get reported at any time. If our version of fjall is vulnerable, we should learn about it ASAP, not just when someone makes an unrelated dependency change.

@SupernaviX SupernaviX merged commit 6766d2b into main Nov 10, 2025
2 checks passed
@SupernaviX SupernaviX deleted the sg/cargo-audit-in-ci branch November 10, 2025 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants