Improve `Env` abstraction by mbg · Pull Request #4004 · github/codeql-action · GitHub

This PR cherry-picks some changes from #3994 and addresses review feedback there related to the new Env abstraction.

Main changes

Functions in action-utils.ts can now be provided with an Env to use. For backwards-compatibility, they default to getEnv() if none is provided.
Split the Env interface into an Env class and a ReadOnlyEnv class.
Moved more code related to environment variables to environment.ts

Out of scope

Using the new abstractions (e.g. ReadOnlyEnv or supplying functions in action-utils.ts with new arguments) everywhere that makes sense.

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.

Warning

Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.

Pull request overview

This PR refactors and centralizes environment-variable handling by introducing ReadOnlyEnv alongside a writable Env, moving GitHub Actions env-var constants into environment.ts, and updating key helpers/tests to support environment injection (defaulting to getEnv() for compatibility).

Changes:

Reworked the environment abstraction: added ReadOnlyEnv, turned Env into a class, and added ActionsEnvVars/new EnvVar entries in src/environment.ts.
Updated actions-util.ts and api-client.ts to accept an injectable environment (defaulting to getEnv()), and adjusted tests accordingly.
Kept backward compatibility by re-exporting env helpers from src/util.ts.

Show a summary per file

File	Description
src/environment.ts	Introduces ReadOnlyEnv/Env classes, adds ActionsEnvVars, and expands EnvVar constants.
src/util.ts	Removes local env helper implementations and re-exports env helpers for backwards compatibility.
src/actions-util.ts	Switches env access to the new Env abstraction and threads an injectable env through several helpers.
src/api-client.ts	Allows getApiDetails/getApiClient to read required env vars via an injected ReadOnlyEnv.
src/testing-utils.ts	Updates test helpers to support setting Actions env vars via Env.
src/api-client.test.ts	Updates tests to pass a test environment object rather than stubbing required env param helpers.
src/setup-codeql.test.ts	Uses EnvVar constants for Code Scanning PR env vars.
src/init.test.ts	Uses ActionsEnvVars constant for RUNNER_ENVIRONMENT.
src/autobuild.ts	Uses ActionsEnvVars.RUNNER_ENVIRONMENT instead of a raw string lookup.
src/config/remote-file.ts	Switches ActionsEnvVars import to environment.ts.
src/config/remote-file.test.ts	Switches ActionsEnvVars import to environment.ts.
lib/entry-points.js	Generated JS output change (not reviewed; diff content excluded by policy).

Review details

Files excluded by content exclusion policy (1)

lib/entry-points.js

Files reviewed: 11/12 changed files
Comments generated: 1
Review effort level: Low

Makes sense.

LGTM

mbg added 10 commits July 9, 2026 12:14

Allow env input for relevant functions in actions-util.ts

8d24507

Allow setting environment variables

4c868b3

Move env var getters out of util.ts

1d0e1b2

Turn Env into a class, and add ReadOnlyEnv

732911a

Add hasChanged method to Env

be67a7b

Move ActionsEnvVars to environment.ts

a440e35

Add RUNNER_ENVIRONMENT to ActionsEnvVars

80dcb7c

Default to getEnv in setupBaseActionsVars

3f2a298

Simplify getTemporaryDirectory

97b52d1

Add CODE_SCANNING_* vars to EnvVar enum

4b164db

mbg requested a review from mario-campos July 9, 2026 13:53

mbg self-assigned this Jul 9, 2026

mbg requested a review from a team as a code owner July 9, 2026 13:53

Copilot AI review requested due to automatic review settings July 9, 2026 13:53

github-actions Bot added the size/L May be hard to review label Jul 9, 2026

Copilot started reviewing on behalf of mbg July 9, 2026 13:54 View session

mbg mentioned this pull request Jul 9, 2026

Allow merging Default Setup config with config file #3994

Merged

Copilot AI reviewed Jul 9, 2026

View reviewed changes

mario-campos approved these changes Jul 9, 2026

View reviewed changes

mbg added this pull request to the merge queue Jul 9, 2026

Merged via the queue into main with commit 37ea21c Jul 9, 2026
226 checks passed

mbg deleted the mbg/env-improvements branch July 9, 2026 15:06

This was referenced Jul 16, 2026

Merge main into releases/v4 #4020

Merged

Merge releases/v4 into releases/v3 #4022

Merged

+              export function getTemporaryDirectory(env: Env = getEnv()): string {
+                return (
+                  env.getOptional(EnvVar.TEMP) ?? env.getRequired(ActionsEnvVars.RUNNER_TEMP)
+                );

Improve `Env` abstraction by mbg · Pull Request #4004 · github/codeql-action · GitHub

Uh oh!

Improve Env abstraction - #4004

Improve Env abstraction#4004
mbg merged 10 commits into
mainfrom
mbg/env-improvements

mbg commented Jul 9, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

mario-campos Jul 9, 2026

Uh oh!

mario-campos left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Improve `Env` abstraction by mbg · Pull Request #4004 · github/codeql-action · GitHub

Uh oh!

Improve Env abstraction - #4004

Improve Env abstraction#4004mbg merged 10 commits intomaingithub/codeql-action:mainfrom mbg/env-improvementsgithub/codeql-action:mbg/env-improvementsCopy head branch name to clipboard

Conversation

mbg commented Jul 9, 2026

Risk assessment

Which use cases does this change impact?

How did/will you validate this change?

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

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

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

Merge / deployment checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Review details

Uh oh!

mario-campos Jul 9, 2026

Choose a reason for hiding this comment

Uh oh!

mario-campos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Improve Env abstraction#4004
mbg merged 10 commits into
mainfrom
mbg/env-improvements