Skip to content

Add required-ready checks for organization docs - #2

Merged
Nicolas0315 merged 4 commits into
mainfrom
codex/org-docs-guard-20260930
Sep 30, 2026
Merged

Nicolas0315 merged 4 commits into
mainfrom
codex/org-docs-guard-20260930

Conversation

@Nicolas0315

@Nicolas0315 Nicolas0315 commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

Purpose

Give the public organization community-health repository an always-on check before any PR can merge.

Changes

  • Validate that README.md and SECURITY.md are present and that README links to SECURITY.md.
  • Check changed lines for whitespace errors on every PR and main push.
  • Use a pinned checkout action and read-only permissions.

Verification

  • actionlint .github/workflows/docs.yml
  • Local document check and staged diff check passed.

Independent review remains required. After this PR's check succeeds, the docs job can become a strict required check. Existing PR #1 will need to pick up the workflow before it can merge.


Note

Low Risk
Adds CI-only validation and whitespace checks with read-only permissions; no runtime or application code changes.

Overview
Adds a new GitHub Actions workflow Organization docs that runs on every pull request and on pushes to main, intended to become a merge-blocking required check for this community-health repo.

The docs job validates that README.md and SECURITY.md exist and are non-empty, and that README.md visibly includes a Markdown table link to ./SECURITY.md (HTML comments and fenced code blocks are stripped before matching). It also runs git diff --check on PR diffs or push ranges to catch whitespace errors in changed lines.

The workflow uses read-only contents permissions, a pinned actions/checkout v4 SHA, full history checkout, and a 5-minute timeout.

Reviewed by Cursor Bugbot for commit 7dcd7bb. Bugbot is set up for automated code reviews on this repo. Configure here.

Copilot AI balanced review requested due to automatic review settings September 29, 2026 20:48
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 29, 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-09-29T20:52:11.566641Z dbd1898 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.

Copilot AI 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.

Copilot review overview

🟡 Changes recommended

The link validation is incomplete, and the push fallback can miss whitespace errors.

Review effort: Balanced
Findings: 2 Medium severity

Open (2)
What changed in this PR

Adds an always-on documentation validation workflow for the organization repository.

Changes:

  • Verifies required public documents exist.
  • Checks README security-policy references.
  • Detects whitespace errors on PRs and main pushes.
File Description
.github/​workflows/​docs.yml Adds the documentation and whitespace validation job.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/docs.yml Outdated
Comment thread .github/workflows/docs.yml Outdated

@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: dbd1898578

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

Comment thread .github/workflows/docs.yml Outdated
Comment thread .github/workflows/docs.yml Outdated
Comment thread .github/workflows/docs.yml Outdated

Copilot AI 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.

Copilot review overview

🔵 Needs a closer look

The link validation permits false positives, and some multi-commit pushes can bypass complete whitespace checking.

Review effort: Balanced
Findings: 2 Medium severity

Open (2)

Copilot AI balanced review requested due to automatic review settings September 30, 2026 04:23
@cursor

cursor Bot commented Sep 30, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_5045e78a-6677-4657-81b7-eada11118129)

Copilot AI 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.

Copilot review overview

🟡 Changes recommended

The Markdown validation can reject valid links after fenced blocks and accept images or escaped examples as links.

Review effort: Balanced
Findings: 1 Medium severity

Open (1)
Resolved since last review (2)

Comment thread .github/workflows/docs.yml Outdated
Copilot AI balanced review requested due to automatic review settings September 30, 2026 04:31
@cursor

cursor Bot commented Sep 30, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_704a1693-a4fc-44cc-b14a-0dc0fd93af42)

Copilot AI 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.

Copilot review overview

🔵 Needs a closer look

The link validator can accept images or inline code instead of a navigable SECURITY link.

Review effort: Balanced
Findings: None

Resolved since last review (1)
Previously missed (1)

In code that hasn't changed since last review

Medium severity Prevent image and inline-code syntax from bypassing SECURITY link check

.github/​workflows/​docs.yml:48

This matcher accepts Markdown that does not render a navigable link. For example, both ![Security](./SECURITY.md) (an image) and an inline-code span containing example: [Security](./SECURITY.md) satisfy the regex, so the required check can pass after the actual SECURITY link is removed. Parse link nodes, or strip inline-code spans and explicitly exclude image syntax before matching.

Copilot AI balanced review requested due to automatic review settings September 30, 2026 04:38
@cursor

cursor Bot commented Sep 30, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_d85a2bab-4244-4722-9990-1a5be6fe88ad)

Copilot AI 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.

Copilot review overview

🟢 Approved

The workflow is narrowly scoped, secure by default, and correctly implements the documented checks.

Review effort: Balanced
Findings: None

@Nicolas0315
Nicolas0315 merged commit 9478d29 into main Sep 30, 2026
3 checks passed
@Nicolas0315
Nicolas0315 deleted the codex/org-docs-guard-20260930 branch September 30, 2026 04:42
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.

2 participants