Skip to content

test(docs): validate reviewer surface links#85

Merged
stacknil merged 1 commit into
mainfrom
codex/validate-reviewer-surface-links
Jun 8, 2026
Merged

test(docs): validate reviewer surface links#85
stacknil merged 1 commit into
mainfrom
codex/validate-reviewer-surface-links

Conversation

@stacknil

@stacknil stacknil commented Jun 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • extend the reviewer route validator to link-check Markdown across the reviewer surface
  • keep the stricter reviewer-route contract checks for the six core route documents
  • document the broader reviewer-surface link coverage in the SBOM reviewer path

Validation

  • python scripts\validate-reviewer-routes.py
  • python -m py_compile scripts\validate-reviewer-routes.py
  • git diff --cached --check
  • git ls-files --eol -- scripts/validate-reviewer-routes.py tools/sbom-diff-and-risk/docs/reviewer-path.md

Privacy

  • changed-file diff scanned for sensitive path, identity, and secret patterns

@stacknil stacknil merged commit 500c1c1 into main Jun 8, 2026
7 checks passed
@stacknil stacknil deleted the codex/validate-reviewer-surface-links branch June 8, 2026 08:18

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8272e96bc7

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

if absolute_root.is_file():
candidates = (absolute_root,) if absolute_root.suffix.lower() == ".md" else ()
else:
candidates = sorted(absolute_root.rglob("*.md"))

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restrict link checks to reviewer files

Because this walks every *.md on disk under tools/sbom-diff-and-risk and projects, the validator now includes local/generated directories as well as checked-in docs. In a common local setup where a developer creates a project-local .venv or other generated tree under one of these roots, the documented python scripts/validate-reviewer-routes.py command can fail on third-party or generated README links that are not part of the reviewer surface. Consider deriving the list from tracked files or excluding hidden/build/virtualenv directories.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant