feat: ratcheting mode for CI adoption on codebases with existing vulnerabilities#598
Merged
Conversation
This file contains hidden or 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
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.
When adopting CVE Lite CLI as a hard CI gate, teams with existing vulnerability debt face an immediate problem:
--fail-onblocks every PR until all pre-existing issues are cleared, which is rarely realistic. Ratcheting solves this by letting teams accept the current state and only fail on new findings introduced above that baseline.How it works
Run once to establish the baseline:
cve-lite . --ratchetThis creates
.cve-lite/baseline.jsonwith all current findings and exits 0. Commit the file.From that point, every scan automatically applies the baseline - no flag needed in CI:
cve-lite . --fail-on highPre-existing findings are suppressed. Only new findings trigger failure.
To reset after fixing vulnerabilities, delete
.cve-lite/baseline.jsonand run--ratchetagain.Output
When baseline is active and all findings are known:
When new findings are detected:
What changed
src/utils/baseline.ts- new utility:readBaseline,writeBaseline,filterNewFindingssrc/types.ts-BaselineEntry,Baselinetypes;ratchet?: booleanonParsedOptionssrc/cli/args.ts---ratchetflag parsingsrc/cli/help.ts- help textsrc/index.ts- baseline auto-load and filtering integrated into scan pipelinetests/baseline.test.ts- 8 unit tests for baseline utilitiesexamples/readme.md- ratcheting usage noteCloses #585