Skip to content

docs: align scan write-up filenames with the findings schema - #357

Open
mldangelo-oai wants to merge 4 commits into
mainfrom
mdangelo/codex/pr-204-scoped-writeup-filename
Open

docs: align scan write-up filenames with the findings schema#357
mldangelo-oai wants to merge 4 commits into
mainfrom
mdangelo/codex/pr-204-scoped-writeup-filename

Conversation

@mldangelo-oai

Copy link
Copy Markdown
Collaborator

Summary

  • Continue docs: align write-up report naming with the findings schema #204 by @mariohercules while preserving the original contributor commit 8afc257019a311a58709c15c6a3dff9c9f001e86 and explicit co-author attribution.
  • Require findings/<slug>/<slug>.md only during Codex Security final reporting so writeup.reportPath satisfies the findings schema.
  • Preserve explicitly requested standalone disclosure directories and filenames, including names with spaces or uppercase letters.
  • Pass the exact selected report path to each one-finding drafting worker.
  • Retain the newer write-up guidance already merged into main.

Fixes #47. Supersedes #204.

Verification

  • 10/10 deterministic Promptfoo artifact-policy evaluations: four scan-finalization cases and six standalone disclosure cases.
  • All four scan outputs accepted by the actual finalize_scan_contract.validate_against_schema production validator.
  • All five explicitly requested standalone filenames preserved; all nine required worker handoffs received the exact output path.
  • Prettier checks passed for both changed Markdown files.
  • git diff --check origin/main...HEAD passed, and both files remain declared in plugin-files.json.
  • Full Bun suite was not run because Bun and the SDK dependencies are not installed in this worktree.

Attribution

The branch is based directly on #204, keeps @mariohercules's original commit, and contains an explicit Co-authored-by trailer so the contribution remains attributed when this squash-only repository merges the change.

mariohercules and others added 4 commits August 1, 2026 20:42
The findings schema requires a write-up's file name to equal its
directory slug:

    "pattern": "^findings/([a-z0-9][a-z0-9._-]*)/\\1\\.md$"

The orchestrating skills state that convention, but the write-up skill
that actually creates the file asked for an "appropriately-named" report
with two differing example file names, neither of which satisfies the
pattern. The sub-agent prompt template passed only an output directory,
so the constraint never reached the worker.

State the `findings/<slug>/<slug>.md` rule in the skill, the report
format reference, and the sub-agent prompt, while keeping the original
intent that the slug stay descriptive rather than `report`.

Fixes #47
Co-authored-by: Mario Hercules <mariohercules@hotmail.com>
@mldangelo-oai

Copy link
Copy Markdown
Collaborator Author

@codex review exact head cca4714

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

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Already looking forward to the next diff.

Reviewed commit: cca4714022

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@chatgpt-codex-connector

Copy link
Copy Markdown

Security review completed. No security issues were found in this pull request.

Reviewed commit: cca4714022

View security finding report

Only the user who started this review can view the report in Codex.

ℹ️ About Codex security reviews in GitHub

This is an experimental Codex feature. Security reviews are triggered when:

  • You comment "@codex security review"
  • A regular code review gets triggered (for example, "@codex review" or when a PR is opened), and you’re opted in so security review runs alongside code review

Once complete, Codex will leave suggestions, or a comment if no findings are found.

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.

vulnerability-writeup instructs a report filename the findings schema rejects

2 participants