GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Add repository property for configuration files by mbg · Pull Request #3963 · github/codeql-action

Conversation

@mbg

@mbg mbg commented Jun 16, 2026

Copy link
Copy Markdown
Member

This PR is the first in a series of changes which will add the ability to point the CodeQL Action at a configuration file using a repository property.

This PR adds the new repository property and uses its value, if provided and no explicit config-file input is provided for the CodeQL Action in the workflow. In other words, the config-file input has priority over the value of the repository property.

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).

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
mbg added 5 commits June 16, 2026 12:02
@mbg
Add github-codeql-config-file property
f57d372
@mbg
Add initial ActionsEnv abstraction
a0276b7
@mbg
Add getConfigFileInput function
ae7c3ea
@mbg
Accept repository property as fallback
8203691
@mbg
Log input choice
b2cc23e
@mbg
mbg requested a review from henrymercer June 16, 2026 21:45
@mbg mbg self-assigned this Jun 16, 2026
@mbg
mbg requested a review from a team as a code owner June 16, 2026 21:46
Copilot AI review requested due to automatic review settings June 16, 2026 21:46
@github-actions github-actions Bot added the size/S Should be easy to review label Jun 16, 2026
Copilot started reviewing on behalf of mbg June 16, 2026 21:47
View session
Copilot AI reviewed Jun 16, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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 introduces a new repository property (github-codeql-config-file) that can provide the CodeQL configuration file location when no explicit config-file workflow input is set, with the workflow input taking precedence. It wires this selection into the init action and adds unit tests around property loading and the selection logic.

Changes:

  • Add RepositoryPropertyName.CONFIG_FILE and parse it from the repository properties API response.
  • Add getConfigFileInput() to resolve the effective config file location (workflow input first, otherwise repository property) and use it from init-action.
  • Add small test utilities and unit tests for both repository property parsing and config file resolution.
Show a summary per file
File Description
src/actions-util.ts Adds an ActionsEnv abstraction and getActionsEnv() to avoid stubbing globals in tests.
src/init-action.ts Uses repository properties + getConfigFileInput() to determine configFile instead of reading the input directly.
src/feature-flags/properties.ts Adds the new github-codeql-config-file repository property to the known/parsed property set.
src/feature-flags/properties.test.ts Extends coverage to ensure the new property is loaded and returned from the API response.
src/config/file.ts New helper for resolving the effective config file from workflow input vs repository property.
src/config/file.test.ts Adds unit tests validating precedence and logging for config file resolution.
src/testing-utils.ts Adds a helper to construct an ActionsEnv for tests.
lib/entry-points.js Excluded from diff (generated/contents unavailable per policy).

Copilot's findings

Files excluded by content exclusion policy (1)
  • lib/entry-points.js
  • Files reviewed: 7/8 changed files
  • Comments generated: 4

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread src/config/file.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/testing-utils.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/feature-flags/properties.test.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/feature-flags/properties.test.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.

@mbg
mbg requested review from mario-campos and removed request for henrymercer June 17, 2026 11:17
@mbg
Ignore empty repository property
52077a0
@github-actions github-actions Bot added size/M Should be of average difficulty to review and removed size/S Should be easy to review labels Jun 17, 2026
mario-campos
mario-campos reviewed Jun 17, 2026
View reviewed changes
Comment thread src/config/file.test.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.

mario-campos
mario-campos approved these changes Jun 17, 2026
View reviewed changes

@mario-campos mario-campos left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM with one minor comment/question.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@mbg
mbg added this pull request to the merge queue Jun 17, 2026
Merged via the queue into main with commit 49e5245 Jun 17, 2026
225 checks passed

Uh oh!

There was an error while loading. Please reload this page.

@mbg
mbg deleted the mbg/repo-prop/config-file branch June 17, 2026 18:23
This was referenced Jun 19, 2026
Cache CLI extractor paths across Actions steps #3950
Closed
Support shorthand forms for getRemoteConfig #3973
Merged
@github-actions github-actions Bot mentioned this pull request Jul 1, 2026
Merge main into releases/v4 #3982
Closed
8 tasks
@mbg mbg mentioned this pull request Jul 1, 2026
Add FF for configuration file repository property #3983
Merged
This was referenced Jul 1, 2026
Merge main into releases/v4 #3984
Merged
Merge releases/v4 into releases/v3 #3992
Merged
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
@mario-campos mario-campos mario-campos approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@mbg mbg

Labels

size/M Should be of average difficulty to review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@mbg @mario-campos
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.