Skip to content

docs: give each scanner import a focused guide - #2201

Merged
mldangelo-oai merged 4 commits into
mainfrom
mdangelo/codex/vendor-guide-cleanup
Nov 1, 2026
Merged

mldangelo-oai merged 4 commits into
mainfrom
mdangelo/codex/vendor-guide-cleanup

Conversation

@mldangelo-oai

@mldangelo-oai mldangelo-oai commented Nov 1, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Make the scanner import guides the starting point for all twelve supported workflows. Readers can choose a report, preview it in their checkout, and follow one set of instructions to store or publish the result.

Changes

  • Link the local and Cloud import workflow from the project README. Add dedicated guides for GitHub code scanning, GitHub Security Advisories, and Wiz.
  • Organize every vendor guide into Quick start, Import and verify, and Reference. Keep each vendor's export steps, source key, and supported inputs together.
  • Consolidate local confirmation, readback, and Cloud guidance. Preserve the Sonar capture workflow, existing SDK section anchors, and distinct GitHub normalization examples for local and Cloud callers.
  • Preserve the selected Semgrep Platform SDK workflow, including repository matching for legacy exports and a preview from an operator-owned SDK project. Distinguish first-time Snyk source keys from the exact destination and key needed for reimports.

Testing

  • Ran the built CLI against synthetic saved reports for all twelve workflows. Sixteen previews, confirmed local imports, and SQLite readbacks passed. Each readback contained the expected unassessed finding.
  • Exercised the Sonar capture workflow with a local stand-in for the collector and GitHub acquisition with a mock transport. Five loopback Cloud tests passed with 145 assertions, covering preview, readback, retry, and deployment selection. No live vendor service or Cloud deployment was contacted.
  • Replayed saved-file and fresh-capture handoffs, repeat imports, and interrupted exports with synthetic inputs. Seven additional tests passed for Cloud credential storage, endpoint selection, receipt recovery, and GitHub advisory state filtering.
  • Checked repository Markdown formatting, 240 repository links, all 187 existing heading anchors, the three-section structure of all twelve guides, and the Git diff.
  • After reconciling with main, ran 122 Semgrep SDK and file-import tests and executed the selected-findings example with synthetic data through readback and replay. Rechecked all 12 guides, 219 relative and same-repository links, 28 shell blocks, and 20 CLI invocations against command help.

Risk and rollout

Documentation only. The examples describe the commands and readers on main. Existing SDK reference anchors are preserved for readers who bookmarked them.

Public disclosure review

  • No customer, partner, prospect, or user identities, data, or identifying details are included.
  • No credentials, personal data, private source, scan findings, or nonpublic links or tickets are included.
  • I reviewed the branch name, title, description, commits, changes, comments, logs, screenshots, attachments, and links for public disclosure.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 1, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 1, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-01T18:35:40.633812Z c61a101 New commits
🔒 Security Review ✅ Completed 2026-11-01T18:36:22.779927Z c61a101 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@alandelong-oai alandelong-oai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for consolidating these workflows. No blocking findings in this owner-level merge-safety review. The documentation-only reorganization preserves source identity, local/Cloud confirmation and retry behavior, and Sonar capture replay. Markdown, SDK/plugin builds, repository links and anchors, and 19 synthetic export probes passed.

The focused suite was not green: 286 passed, 1 skipped, and 87 failed because fixture ancestry triggered existing path protections. Local persistence was therefore not successfully verified end to end; those environment failures do not indicate a regression in this docs-only change.

@alandelong-oai alandelong-oai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for consolidating these guides and preserving the updated workflows. No blocking findings in this owner-level merge-safety review of c61a101. The Snyk replay instructions retain the original destination/source key, and the Semgrep SDK example runs from an operator-controlled project outside the scanned checkout.

Markdown, SDK/plugin builds, types, 170 focused tests, and 23 synthetic acquisition probes passed. Six integration tests failed at existing filesystem ancestry/ownership protections; local persistence and Cloud loopback publication remain unverified end to end. No live vendor or Cloud deployment was contacted.

@mldangelo-oai
mldangelo-oai merged commit 4694a0b into main Nov 1, 2026
45 checks passed
@mldangelo-oai
mldangelo-oai deleted the mdangelo/codex/vendor-guide-cleanup branch November 1, 2026 18:52
@github-actions github-actions Bot mentioned this pull request Nov 1, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants