Add repository property for `tools` input by mbg · Pull Request #4037 · github/codeql-action

mbg · 2026-07-22T13:42:05Z

This PR attempts to simplify and tidy up #3766 while resolving conflicts with recent changes to the codebase.

Compared with #3766, there are the following changes:

The repository property's behaviour is gated by a new FF.
There is no github-codeql-tools-mode property. The justification for this is that in Advanced Setup workflows, the tools input provided in the workflow takes precedence. The value of the repository property can be enforced with a prefix !. This is similar to the + notation for the queries input, where + means "combine rather than replace".
This PR does not change the telemetry to include the source of the effective tools value. However, it does lay the groundwork for it with the EffectiveInput type and getToolsInput returns a suitable value. Once we have merged relevant backend changes, the intention is to then make use of EffectiveInput values in the status reports. This will avoid duplication of work across similar inputs (i.e. rather than adding several new status reports properties for each, we will have an array of EffectiveInput values). That's outside the scope of this PR though.
Like Add github-codeql-tools repository property for tools input #3766, this PR also updates setup-codeql to load the repository properties. Since the loaded values are not persisted, this means that both setup-codeql and init could load them. However, we don't yet allow setup-codeql in the same workflow as init, so this is not an issue right now. If we allow setup-codeql before init in the future, we will need to review potentially duplicated work across both steps in any case.

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.

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?

Feature flags - All new or changed code paths can be fully disabled with corresponding feature flags.

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.

Copilot

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

Adds feature-flagged support for sourcing the tools input from repository properties.

Changes:

Adds github-codeql-tools property and feature flag.
Introduces effective-input precedence and enforcement handling.
Integrates repository properties into init and setup-codeql.

Show a summary per file

File	Description
`src/config/inputs.ts`	Resolves effective `tools` input.
`src/config/inputs.test.ts`	Tests input precedence and enforcement.
`src/feature-flags.ts`	Defines the new feature flag.
`src/feature-flags/properties.ts`	Adds and loads the tools property.
`src/feature-flags/properties.test.ts`	Tests tools-property parsing.
`src/init-action.ts`	Uses the effective tools value during initialization.
`src/setup-codeql-action.ts`	Adds property support to setup.
`lib/entry-points.js`	Generated file; excluded from review by policy.

Review details

Files excluded by content exclusion policy (1)

lib/entry-points.js

Files reviewed: 7/8 changed files
Comments generated: 3
Review effort level: Medium

Copilot

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.

Review details

Files excluded by content exclusion policy (1)

lib/entry-points.js

Files reviewed: 9/10 changed files
Comments generated: 2
Review effort level: Medium

+): Promise<ComputedInput | undefined> {
+ const name = InputName.Tools;
+ const input = action.actions.getOptionalInput(name);
+ const propertyValue = repositoryProperties[RepositoryPropertyName.TOOLS];


Copilot

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.

Review details

Files excluded by content exclusion policy (1)

lib/entry-points.js

Files reviewed: 9/10 changed files
Comments generated: 0 new
Review effort level: Medium

oscarsj

👍🏾 I think most of the code in getToolsInput might be generalized and be reused when getting other repository properties, but we can deal with that when really needed.

mbg · 2026-07-24T13:18:59Z

👍🏾 I think most of the code in getToolsInput might be generalized and be reused when getting other repository properties, but we can deal with that when really needed.

Yep, that was my idea when I put it together, but I didn't want to add a bunch of refactoring for the other repo properties to this PR.

mbg added 6 commits July 22, 2026 13:28

Add github-codeql-tools property
009715d

Add FF for tools repository property
1f57eb0

Move loadRepositoryProperties to properties.ts
f58d696

Load repository properties in setup-codeql action
3479f3f

Add and use getToolsInput
49f2e37

Check log messages in tests
32ed58d

mbg requested a review from oscarsj July 22, 2026 13:42

mbg self-assigned this Jul 22, 2026

mbg requested a review from a team as a code owner July 22, 2026 13:42

CopilotAI review requested due to automatic review settings July 22, 2026 13:42

Copilotstarted reviewing on behalf of mbg July 22, 2026 13:42 View session

github-actionsBot added the size/L May be hard to review label Jul 22, 2026

CopilotAI reviewed Jul 22, 2026
View reviewed changes

Comment threadsrc/setup-codeql-action.ts
Comment threadsrc/init-action.ts
Comment threadsrc/setup-codeql-action.ts

mbg added 2 commits July 22, 2026 16:54

Rename to ComputedInput
be24c11

Include computed tools value in computed_inputs
f9442c4

CopilotAI review requested due to automatic review settings July 22, 2026 16:03

Copilotstarted reviewing on behalf of mbg July 22, 2026 16:04 View session

CopilotAI reviewed Jul 22, 2026
View reviewed changes

Comment threadsrc/status-report.ts
Comment threadsrc/config/inputs.ts
): Promise<ComputedInput | undefined> {
const name = InputName.Tools;
const input = action.actions.getOptionalInput(name);
const propertyValue = repositoryProperties[RepositoryPropertyName.TOOLS];

Merge remote-tracking branch 'origin/main' into mbg/repo-props/tools
372f165

CopilotAI review requested due to automatic review settings July 23, 2026 10:57

Copilotstarted reviewing on behalf of mbg July 23, 2026 10:57 View session

CopilotAI reviewed Jul 23, 2026
View reviewed changes

oscarsj previously approved these changes Jul 24, 2026
View reviewed changes

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

mbg removed this pull request from the merge queue due to a manual request Jul 24, 2026

mbg added 3 commits July 24, 2026 14:24

Merge remote-tracking branch 'origin/main' into mbg/repo-props/tools
b060f9d

Remove name field from ComputedInput
f170b3a

Add changelog entry
1564bfa

mbg dismissed oscarsj’s stale review via 1564bfaJuly 24, 2026 13:43

mbg requested a review from oscarsj July 24, 2026 13:46

oscarsj approved these changes Jul 24, 2026
View reviewed changes

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

github-merge-queueBot removed this pull request from the merge queue due to failed status checks Jul 24, 2026

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

mbg mentioned this pull request Jul 24, 2026
Add github-codeql-tools repository property for tools input #3766
Closed

Merged via the queue into main with commit 4c0a1f0Jul 24, 2026
225 checks passed

mbg deleted the mbg/repo-props/tools branch July 24, 2026 15:31

This was referenced Jul 29, 2026
Merge main into releases/v4 #4053
Merged
Merge releases/v4 into releases/v3 #4058
Merged

Navigation Menu

Uh oh!

Add repository property for `tools` input - #4037

Add repository property for `tools` input#4037
mbg merged 12 commits into
mainfrom
mbg/repo-props/tools

mbg commented Jul 22, 2026•
edited
Loading

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

oscarsj left a comment

Uh oh!

mbg commented Jul 24, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

mbg commented Jul 22, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Review details

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Review details

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Review details

Uh oh!

oscarsj left a comment

Choose a reason for hiding this comment

Uh oh!

mbg commented Jul 24, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mbg commented Jul 22, 2026•
edited
Loading