Skip to content

docs: clarify CodeQL scan and merge policy - #868

Merged
haofeif merged 1 commit into
mainfrom
docs/codeql-scan-and-merge-policy
Oct 3, 2026
Merged

haofeif merged 1 commit into
mainfrom
docs/codeql-scan-and-merge-policy

Conversation

@haofeif

@haofeif haofeif commented Oct 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

Documentation-only follow-up to #858; refs #857.

  • Explain the PR test-merge revision and distinguish scan completion from merge permission.
  • Document the PR-diff alert thresholds, required language checks, and default-branch baseline.
  • Make explicit that the current policy does not require zero open alerts across the repository before every PR can merge.
  • Add examples for new qualifying findings, unchanged baseline alerts, and failed uploads, with GitHub's documented limitations.

Scope

Only SECURITY.md changes. No workflows, queries, permissions, branch rules, application code, or alert states are changed. The remaining controlled acceptance work in #857 is not completed by this documentation PR.

Validation

  • uv run --no-sync python scripts/validate_markdown_links.py
  • git diff --check -- SECURITY.md

Document the PR merge revision, scan completion versus merge enforcement, severity thresholds, and treatment of existing baseline alerts. No CI behavior changes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings October 3, 2026 02:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The documentation accurately reflects the configured workflow and stated merge policy without changing behavior.

Review effort: Balanced
Findings: None

What changed in this PR

Clarifies how CodeQL scan completion differs from merge eligibility and how baseline alerts affect PRs.

Changes:

  • Documents PR merge-revision scanning and required checks.
  • Explains alert thresholds, baseline handling, and merge-rule limitations.
  • Adds representative success and failure scenarios.
File Description
SECURITY.md Clarifies CodeQL scan scope and merge policy.

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

@haofeif
haofeif merged commit af894da into main Oct 3, 2026
26 checks passed
@haofeif
haofeif deleted the docs/codeql-scan-and-merge-policy branch October 3, 2026 02:20
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