Emit warning for unrecognised repo properties with our common prefix#3570
Open
Emit warning for unrecognised repo properties with our common prefix#3570
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a warning when the action sees a repository property that looks like it belongs to the CodeQL Action (matches the shared prefix) but isn’t recognized by the current version, to help users diagnose version/property mismatches.
Changes:
- Introduce a shared
GITHUB_CODEQL_PROPERTY_PREFIXconstant and warn on unknown prefixed properties inloadPropertiesFromApi. - Add a unit test asserting a warning is emitted for an unrecognized prefixed property.
- Regenerate the compiled
lib/output.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/feature-flags/properties.ts | Adds the common prefix constant and warning behavior for unknown prefixed properties (with a dynamic-workflow suppression). |
| src/feature-flags/properties.test.ts | Adds unit coverage for the new warning behavior. |
| lib/init-action.js | Generated output reflecting the TypeScript changes (not reviewed). |
esbena
approved these changes
Mar 12, 2026
Contributor
esbena
left a comment
There was a problem hiding this comment.
LGTM, with a minor concern on how spammy this could become in practice.
Comment on lines
+134
to
+139
| logger.warning( | ||
| `Found a repository property named '${property.property_name}', ` + | ||
| "which looks like a CodeQL Action repository property, " + | ||
| "but which is not understood by this version of the CodeQL Action. " + | ||
| "Do you need to update to a newer version?", | ||
| ); |
Contributor
There was a problem hiding this comment.
Users running old versions for whatever reasons will start seeing more and more log lines over time. Should we collapse to a single warning line and then have ...${unrecognized.join(", ")}... mentioning them all in a list?
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
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.
Adds a warning to
loadPropertiesFromApiwhen it encounters a repository property whose name matches our common prefix, but isn't one we recognise.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
Products:
analysis-kinds: code-scanning.Environments:
github.comand/or GitHub Enterprise Cloud with Data Residency.How did/will you validate this change?
.test.tsfiles).pr-checks).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