FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Emit warning for unrecognised repo properties with our common prefix by mbg · Pull Request #3570 · github/codeql-action · GitHub

/ codeql-action Public

Emit warning for unrecognised repo properties with our common prefix - #3570

Merged
mbg merged 2 commits into
mainfrom
mbg/repo-props/warn-on-unexpected-props
Mar 13, 2026
ConversationCommits (2)ChecksFiles changed
Merged

Emit warning for unrecognised repo properties with our common prefix#3570
mbg merged 2 commits into
mainfrom
mbg/repo-props/warn-on-unexpected-props

Conversation

mbg commented Mar 12, 2026

Copy link
Copy Markdown
Member

Adds a warning to loadPropertiesFromApi when 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:

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

Products:

  • Code Scanning - The changes impact analyses when analysis-kinds: code-scanning.

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?

  • Special considerations - This change should only be merged once certain preconditions are met. Please provide details of those or link to this PR from an internal issue.

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.

mbg self-assigned this Mar 12, 2026
mbg requested a review from a team as a code owner March 12, 2026 11:51
Copilot AI review requested due to automatic review settings March 12, 2026 11:51
github-actions Bot added the size/S Should be easy to review label Mar 12, 2026
Copilot AI reviewed Mar 12, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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_PREFIX constant and warn on unknown prefixed properties in loadPropertiesFromApi.
  • 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).

Comment thread src/feature-flags/properties.ts Outdated
Comment thread src/feature-flags/properties.ts
Comment thread src/feature-flags/properties.ts
esbena previously approved these changes Mar 12, 2026
View reviewed changes

esbena left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM, with a minor concern on how spammy this could become in practice.

Comment thread src/feature-flags/properties.ts Outdated
mbg requested a review from esbena March 13, 2026 11:01
esbena approved these changes Mar 13, 2026
View reviewed changes

esbena left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks.

mbg enabled auto-merge March 13, 2026 11:06
mbg added this pull request to the merge queue Mar 13, 2026
Merged via the queue into main with commit 4c356c7 Mar 13, 2026
225 checks passed
mbg deleted the mbg/repo-props/warn-on-unexpected-props branch March 13, 2026 11:32
github-actions Bot mentioned this pull request Mar 16, 2026
Merged
8 tasks
mbg added a commit that referenced this pull request Mar 16, 2026
Add changelog entry for #3570
e682234
github-actions Bot mentioned this pull request Mar 16, 2026
Merged
8 tasks
sam-robson added a commit that referenced this pull request Mar 18, 2026
Merge branch 'main' into kaspersv/move-diff-range-absolute-path-conve…
5e54629 
…rsion

* main: (112 commits)
  Rebuild
  Update changelog and version after v4.33.0
  Add changelog entry for #3570
  Bump minor version
  Update changelog for v4.32.7
  Only emit one message with accumulated property names
  Remove `cache-dependency-path` options as well
  Remove `package-lock.json` that's no longer needed
  Add step (in root directory) to install dependencies
  Add explicit cache dependency paths in `pr-checks.yml`
  Fix linter errors in `sync-back.test.ts`
  Fix linter errors in `sync-back.ts`
  Rename `sync_back` to `sync-back`
  Fix linter errors in `sync.ts`
  Add eslint configuration for `pr-checks`
  Add minimal `Step` type
  Add `workspaces` to root `package.json`
  Avoid bundling `package.json`
  Move `ava` config out of `package.json`
  Emit warning for unrecognised repo properties with our common prefix
  ...

# Conflicts:
#	lib/init-action-post.js
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
Show hidden characters
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
esbena esbena approved these changes

Assignees

mbg

Labels

size/S Should be easy to review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL