docs: comparison page — what bomdrift catches that others miss (closes #33)#59
Merged
Conversation
Closes #33. Walks five published incidents (xz-utils, event-stream, ua-parser-js, colors.js, node-ipc) and calls out for each which bomdrift signals would have fired pre-disclosure and which would not. Honest about the misses: colors.js and node-ipc are post-advisory catches only, since the malicious payloads were patch-level changes by long-tenured maintainers. Methodology section names the enricher modules backing each judgement and flags reproducible fixture SBOMs as follow-up work (not yet committed). - docs/src/comparison.md (new) - docs/src/SUMMARY.md (link under Project) - README.md (cross-reference under comparison table)
Coverage reportLine coverage: 84.6% (10029 / 11851 lines) Full lcov report available as workflow artifact coverage-lcov: download from this run. v0.9.8 introduces this report; |
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
1 participant
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.
Closes #33.
Adds
docs/src/comparison.mdwalking five published supply-chain incidents and calling out, per signal, which would have fired pre-disclosure on the PR that pulled in the compromised release:Tone follows the issue's ask: where bomdrift would not have caught an incident, the page says so explicitly. The credibility of this page matters more than its length.
What's NOT in this PR
The issue calls for fixture SBOMs under
tests/fixtures/comparison/so the CLI invocations are reproducible. That requires capturing historical npm / OSV / registry responses frozen at the incident date, which is a separate piece of work — flagged as a follow-up in the page's "Follow-ups" section and not blocking the v1.0 cut on this PR. Happy to scope a follow-on if you want it before tag.Verification
docs/src/comparison.mdparses; 5 case studies + signal-summary table + methodology.SUMMARY.mdunder "Project" and fromREADME.mdunder the comparison table.main.Repo-policy reminder:
mainrequires verified signatures. This branch is unsigned; "Merge" or "Squash" via the GitHub UI will auto-sign the resulting commit.