FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Record the job that published an overlay status by henrymercer · Pull Request #3537 · github/codeql-action · GitHub

/ codeql-action Public

Record the job that published an overlay status - #3537

Merged
henrymercer merged 3 commits into
mainfrom
henrymercer/overlay-status-record-job
Mar 4, 2026
ConversationCommits (3)ChecksFiles changed
Merged

Record the job that published an overlay status#3537
henrymercer merged 3 commits into
mainfrom
henrymercer/overlay-status-record-job

Conversation

henrymercer commented Mar 3, 2026

Copy link
Copy Markdown
Contributor

This makes it easier to find the job that produced the status.

Risk assessment

For internal use only. Please select the risk level of this change:

  • Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

Workflow types:

  • Advanced setup - Impacts users who have custom CodeQL workflows.
  • Managed - Impacts users with dynamic workflows (Default Setup, Code Quality, ...).

Products:

  • Code Scanning - The changes impact analyses when analysis-kinds: code-scanning.

Environments:

  • Dotcom - Impacts CodeQL workflows on github.com and/or GitHub Enterprise Cloud with Data Residency.

How did/will you validate this change?

  • Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

  • Feature flags - All new or changed code paths can be fully disabled with corresponding feature flags.
  • Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

  • Telemetry - I rely on existing telemetry or have made changes to the telemetry.
    • Alerts - New or existing monitors will trip if something goes wrong with this change.

Are there any special considerations for merging or releasing this change?

  • No special considerations - This change can be merged at any time.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Consider adding a changelog entry for this change.
  • Confirm the readme and docs have been updated if necessary.

Record the job that published an overlay status
a05f541 
This makes it easier to find the job that produced the status.
henrymercer requested a review from a team as a code owner March 3, 2026 15:58
Copilot AI review requested due to automatic review settings March 3, 2026 15:58
github-actions Bot added the size/S Should be easy to review label Mar 3, 2026
Copilot AI reviewed Mar 3, 2026
View reviewed changes

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Pull request overview

This PR adds job identification metadata to the overlay analysis status file stored in the GitHub Actions cache. When an overlay-base analysis fails to complete, the action now records the workflow run ID, run attempt number, and job name alongside the failure status, making it easier to trace which job produced the status.

Changes:

  • New JobInfo interface and optional job field in OverlayStatus, plus a createOverlayStatus factory function that auto-populates job details from environment variables
  • Refactored recordOverlayStatus in the post-helper to use createOverlayStatus instead of an object literal
  • Updated tests to set the new required env vars and assert that job details are included in the saved overlay status

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
src/overlay/status.ts Defines JobInfo interface, adds optional job field to OverlayStatus, adds createOverlayStatus factory
src/init-action-post-helper.ts Uses new createOverlayStatus helper when recording overlay failure status
src/init-action-post-helper.test.ts Sets GITHUB_RUN_ID, GITHUB_RUN_ATTEMPT, GITHUB_JOB env vars and asserts job info in saved status
lib/init-action-post.js Auto-generated JS reflecting the TS source changes (not reviewed per convention)

mbg previously approved these changes Mar 3, 2026
View reviewed changes

mbg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks good. Just one small suggestion, but it's not really specific to this PR and would be out-of-place as a change here.

Comment thread src/init-action-post-helper.test.ts
Comment on lines 318 to 322
process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
process.env["GITHUB_RUN_ID"] = "12345";
process.env["GITHUB_RUN_ATTEMPT"] = "1";
process.env["GITHUB_JOB"] = "analyze";
process.env["RUNNER_TEMP"] = tmpDir;

mbg Mar 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Minor: It might be nice to extend setupActionsVars with all environment variables that we'd typically expect in an Actions environment and modify it to accept an argument with a (partial) mapping of specific environment variables we want to set. Not necessarily something for this PR.

henrymercer Mar 3, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Good idea. I'll take a look at this in a separate PR.

henrymercer added this pull request to the merge queue Mar 3, 2026
henrymercer removed this pull request from the merge queue due to a manual request Mar 3, 2026
mbg reviewed Mar 3, 2026
View reviewed changes
Comment thread src/overlay/status.ts Outdated
Comment thread src/init-action-post-helper.ts Outdated
henrymercer mentioned this pull request Mar 4, 2026
Merged
henrymercer requested a review from mbg March 4, 2026 11:32
henrymercer added this pull request to the merge queue Mar 4, 2026
Merged via the queue into main with commit a5b959e Mar 4, 2026
244 checks passed
henrymercer deleted the henrymercer/overlay-status-record-job branch March 4, 2026 12:13
This was referenced Mar 5, 2026
Merged
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
mbg mbg approved these changes

Assignees

No one assigned

Labels

size/S Should be easy to review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL