Skip to content

Use runInActions/ActionState for all actions - #4254

Open
mbg wants to merge 14 commits into
mainfrom
mbg/all-action-state
Open

mbg wants to merge 14 commits into
mainfrom
mbg/all-action-state

Conversation

@mbg

@mbg mbg commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

Primarily a refactor which updates all of our actions (and post-actions) to use runInActions and, by extension, ActionState. That ensures consistency across the different actions and means we can take advantage of ActionState in their respective call trees going forward.

This PR also makes minimal changes to the entry points to start make use of ActionState there.

I have also made the Action display names that are reported in unhandled error messages when they are logged more consistent.

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.
  • Code Quality - The changes impact analyses when analysis-kinds: code-quality.
  • Other first-party - The changes impact other first-party analyses.
  • Third-party analyses - The changes affect the upload-sarif action.

Environments:

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

How did/will you validate this change?

  • Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).
  • End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks).

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

  • 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.
    • Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release.
    • 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.

@github-actions github-actions Bot added the size/M Should be of average difficulty to review label Oct 19, 2026
@mbg
mbg force-pushed the mbg/all-action-state branch from fdc373d to 7a6a2ca Compare October 19, 2026 20:59
@mbg
mbg force-pushed the mbg/all-action-state branch from 7a6a2ca to 00434f0 Compare October 21, 2026 15:50
@github-actions github-actions Bot added size/L May be hard to review and removed size/M Should be of average difficulty to review labels Oct 21, 2026
@mbg
mbg marked this pull request as ready for review October 21, 2026 15:52
@mbg
mbg requested a review from a team as a code owner October 21, 2026 15:52
Copilot AI max review requested due to automatic review settings October 21, 2026 15:52

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.

🟡 Changes recommended

Centralized input restoration overwrites the runtime cancellation status, causing cancelled analyses to cache an unnecessary failure.

3 open issues
1 file not reviewed
What changed in this PR

Standardizes CodeQL action entry points around runInActions and ActionState for consistent execution and shared state access.

Changes:

  • Centralizes post-action input restoration.
  • Extends action-state APIs and test helpers.
  • Standardizes action display names and failure messages.
File Description
src/​upload-sarif-action-post.ts Adopts the shared runner and action state.
src/​testing-utils.ts Adds failure tracking and state access for tests.
src/​status-report.ts Adds post-action identifiers and consistent display names.
src/​start-proxy-action-post.ts Moves proxy cleanup into the shared runner.
src/​resolve-environment-action.ts Uses action state for inputs and reporting.
src/​init-action-post.ts Adopts centralized restoration and state-based APIs.
src/​analyze-action-post.ts Adopts the shared runner and environment access.
src/​actions-util.ts Extends action APIs and refactors input restoration.
src/​action-common.ts Restores post-action inputs before execution.
src/​action-common.test.ts Updates display-name and failure-message assertions.

Review effort: Max

Comment thread src/actions-util.ts

for (const [name, value] of persistedInputs) {
process.env[name] = value;
action.env.set(name, value);

/** The main entry point for the `start-proxy` post-action. */
export async function runWrapper() {
await runInActions(startProxyPostAction);
Comment thread src/status-report.ts
StartProxy = "start-proxy",
StartProxyPost = "start-proxy-post",
UploadSarif = "upload-sarif",
UploadSarifPost = "upload-sarif-post",

This branch has not been deployed

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

Labels

size/L May be hard to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants