chore(security): document that the CodeQL job name gates merges to main - #1912
Closed
lskramarov wants to merge 1 commit into
Closed
chore(security): document that the CodeQL job name gates merges to main#1912lskramarov wants to merge 1 commit into
lskramarov wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Documents that the CodeQL workflow’s job name is part of the merge gate, because Analyze is configured as a required status check on main. This helps prevent accidental edits (renames or paths: filtering) that would break branch protection expectations by eliminating/renaming the check run.
Changes:
- Add an inline comment in
.github/workflows/codeql.ymlexplaining that theAnalyzejob name must remain stable because it gates merges tomain.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
Visit the preview URL for this PR (updated for commit c41087c): https://koobiq-next--prs-1912-pl5rz5ay.web.app (expires Fri, 21 Aug 2026 07:07:03 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: c9e37e518febda70d0317d07e8ceb35ac43c534c |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Analyzeis now a required status check onmain, so the job name incodeql.ymlis part of themerge gate rather than a cosmetic label. This adds a comment saying so, next to the name it protects.
Why
The last open code scanning alert (#26)
is OpenSSF Scorecard's SAST check, not a code vulnerability — it has no file attached:
Scorecard reads the last 30 commits of the default branch and, for each one that came from a merged
PR, looks for a successful check run from the
github-advanced-securityapp on that PR's head SHA.All six non-compliant commits are PRs whose heads predate
codeql.yml, which landed onmainon2026-08-11 in 42439d0 (#1877): #1870, #1871, #1872, #1873, #1874 and #1878. Every one of the 23 PRs
merged since then passes, Dependabot's included, so the workflow itself needed no change and the
alert clears itself once those six commits fall out of the 30-commit window.
What did need fixing is that
mainhad no required status checks at all, so nothing stopped a PRfrom merging with CodeQL failed or skipped. That is not hypothetical: on 2026-08-17 the run on
fix/DS-5407failed with a transient GitHub-side error while uploading SARIF(
No server is currently available to service your request). Had that PR been merged on that headSHA, it would have produced a permanently non-compliant commit and re-opened the alert.
Analyzehas been added as a required check in branch protection (strict: false, so branches arenot forced to be up to date before merging). This comment records the consequence for whoever edits
the workflow next.
Notes
context nothing reports.
paths:filter would deadlock the same way: a filtered-out workflow creates no check run at all.