Skip to content

Add Api, ReadOnlyEnv, and Base state features#4009

Open
mbg wants to merge 6 commits into
mainfrom
mbg/action-state/additions
Open

Add Api, ReadOnlyEnv, and Base state features#4009
mbg wants to merge 6 commits into
mainfrom
mbg/action-state/additions

Conversation

@mbg

@mbg mbg commented Jul 14, 2026

Copy link
Copy Markdown
Member

A small PR adding new Api and ReadOnlyEnv features to the state features available through ActionState. This also changes the BaseState to only be available if explicitly requested with the new Base feature. This allows us to retrofit ActionState more easily to existing code, since we don't need to get hold of the startedAt time and the action name, if those aren't needed.

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.

@mbg mbg self-assigned this Jul 14, 2026
@mbg mbg requested a review from a team as a code owner July 14, 2026 09:44
Copilot AI review requested due to automatic review settings July 14, 2026 09:44
@github-actions github-actions Bot added the size/S Should be easy to review label Jul 14, 2026

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.

Pull request overview

Adds opt-in Base, Api, and ReadOnlyEnv features to ActionState.

Changes:

  • Makes base state explicitly requested.
  • Adds API-client and read-only environment state features.
  • Updates action and test-state typings.
Show a summary per file
File Description
src/action-common.ts Defines new state features and optional base state.
src/api-client.ts Exports the API client type.
src/testing-utils.ts Initializes all new features in test state.
src/analyze-action.ts Requests base state.
src/autobuild-action.ts Requests base state.
src/init-action.ts Requests base state.
src/setup-codeql-action.ts Requests base state.
src/upload-sarif-action.ts Requests base state.

Review details

  • Files reviewed: 8/8 changed files
  • Comments generated: 2
  • Review effort level: Medium

Comment thread src/api-client.ts
Comment thread src/action-common.ts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Should be easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants