Add support for the repository properties API - #3126
Merged
mbg merged 23 commits intoSep 23, 2025
Merged
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
mbg
force-pushed
the
mbg/add/properties-api
branch
from
b8fc51c to
8cba882
Compare
September 20, 2025 12:02
mbg
force-pushed
the
mbg/add/properties-api
branch
from
8cba882 to
c7eb488
Compare
September 20, 2025 13:09
mbg
force-pushed
the
mbg/refactor/db-config-and-errors
branch
from
96ca55b to
a067418
Compare
September 20, 2025 13:10
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for the Repository Properties API to the CodeQL Action, enabling organization-wide query configuration through repository properties.
Key changes:
- Adds Repository Properties API integration to fetch property values during initialization
- Implements query precedence system where repository properties have highest priority, followed by action inputs, then config file settings
- Introduces combining logic for repository property queries similar to existing action inputs
Reviewed Changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 2 comments.
Show a summary per file| File | Description |
|---|---|
| src/feature-flags/properties.ts | New module for Repository Properties API integration and property name enumeration |
| src/init-action.ts | Adds repository properties loading during action initialization |
| src/config/db-config.ts | Implements query combination logic with repository property precedence |
| src/error-messages.ts | Adds error message functions for repository property validation |
| src/config-utils.ts | Updates Config interface and initialization to include repository properties |
| src/testing-utils.ts | Updates test utilities to include repository properties field |
| package.json | Simplifies test script pattern matching |
| lib/*.js | Generated JavaScript files reflecting the TypeScript changes |
| .github/actions/check-codescanning-config/index.ts | Adds query array sorting for deterministic config comparison |
Sorry, something went wrong.
Comment thread
src/feature-flags/properties.ts
Outdated
Comment thread
.github/actions/check-codescanning-config/index.ts
Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
henrymercer
reviewed
Sep 22, 2025
henrymercer
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Looks like some additional config normalisation is needed in the tests, otherwise LGTM.
Sorry, something went wrong.
Comment thread
src/config/db-config.ts
henrymercer
reviewed
Sep 22, 2025
Comment thread
src/actions-util.ts
Outdated
mbg
force-pushed
the
mbg/add/properties-api
branch
from
840c9ad to
05310c6
Compare
September 22, 2025 15:32
Also add `logger.debug` call with keys from API response
henrymercer
previously approved these changes
Sep 23, 2025
henrymercer
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Looks reasonable, and the test run checks out.
Sorry, something went wrong.
Comment thread
src/feature-flags/properties.ts
Outdated
Comment thread
src/config/db-config.ts
Outdated
henrymercer
previously approved these changes
Sep 23, 2025
Comment thread
src/config/db-config.ts
henrymercer
approved these changes
Sep 23, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
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.
This PR has two main contributions:
For the Repository Properties support, we fetch the list of repository properties at the start of the init Action. We filter this down to known properties (i.e. ones we care about) and store their values. The mapping of known property names to their values is then included in the Action state (i.e. the Config type) so that it remains accessible to other CodeQL Action steps in the same workflow and with consistent values.
For the query augmentation, we give the value obtained from the Repository Properties the highest precedence. This is because the intention here is to allow organisations to configure org-wide queries to include in analyses.
Risk assessment
For internal use only. Please select the risk level of this change:
Merge / deployment checklist