Skip to content

docs(examples): add findings CSV validation guidance - #649

Merged
mldangelo-oai merged 2 commits into
mainfrom
mdangelo/codex/examples-readme
Aug 26, 2026
Merged

docs(examples): add findings CSV validation guidance#649
mldangelo-oai merged 2 commits into
mainfrom
mdangelo/codex/examples-readme

Conversation

@mldangelo-oai

@mldangelo-oai mldangelo-oai commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Summary

Make the findings CSV example easier to validate before publication by adding
an exact dry-run command and linking directly to the CSV input rules.

Changes

  • Clarify that each findings CSV row represents one finding.
  • Add an npx @openai/codex-security publish scan --to cloud --csv ... --dry-run --json validation example.
  • Link directly to the documentation for required columns and input rules.

Testing

  • git diff --check origin/main...HEAD
  • npm exec --yes --package=prettier@3.2.5 -- prettier --check examples/README.md
  • Verified the README's relative link targets and #publish-findings-to-cloud anchor resolve.

Risk and rollout

Documentation only. This describes existing CLI behavior and does not change
runtime behavior, package manifests, or tarball contents. No rollout is required.

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 Aug 25, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 25, 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-08-26T02:03:14.495878Z 6a12235 New commits
🔒 Security Review Completed 2026-08-25T22:29:07.977333Z 873ae81 PR opened
ℹ️ 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.

@mldangelo-oai mldangelo-oai changed the title docs: describe repository examples docs(examples): add findings CSV validation guidance Aug 26, 2026
@mldangelo-oai
mldangelo-oai merged commit a55f342 into main Aug 26, 2026
57 checks passed
@mldangelo-oai
mldangelo-oai deleted the mdangelo/codex/examples-readme branch August 26, 2026 05:44
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