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 support for an explicit remote path prefix by mbg · Pull Request #4014 · github/codeql-action

Conversation

@mbg

@mbg mbg commented Jul 15, 2026 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Member

This is an alternative to #4012 which addresses the same issue. The first few commits here are the same as there and increase test coverage and refactor a couple of functions.

The approach to resolving the issue here is different, however: instead of trying to find the file locally as in #4012 and always treat ambiguous paths as remote paths, we instead add support for a prefix that allows user to explicitly indicate that a configuration file path is supposed to refer to a remote file.

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?

  • Test repository - This change will be tested on a test repository before merging.
  • 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.

Sorry, something went wrong.

Uh oh!

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

All reactions
mbg added 7 commits July 15, 2026 14:31
@mbg
Add tests for loadUserConfig
9c0c11a
@mbg
Add failing test for the issue
c73d965
@mbg
Refactor parseNewRemoteFileAddress out of parseRemoteFileAddress
9832a9d
@mbg
Split up and document isLocal
6d3bde3
@mbg
Move the local path prefix into a constant
001d4ae
@mbg
Add AssertableTarget interface
57ca205
@mbg
Add expliciit prefix for remote file addresses
2333995
@mbg mbg self-assigned this Jul 15, 2026
@mbg
mbg requested a review from a team as a code owner July 15, 2026 15:03
Copilot AI review requested due to automatic review settings July 15, 2026 15:03
@github-actions github-actions Bot added the size/M Should be of average difficulty to review label Jul 15, 2026
Copilot started reviewing on behalf of mbg July 15, 2026 15:03
View session
@mbg
mbg requested review from henrymercer and mario-campos July 15, 2026 15:05
Copilot AI reviewed Jul 15, 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

Adds an explicit :: prefix to disambiguate remote CodeQL configuration paths.

Changes:

  • Adds local/remote path prefix handling.
  • Refactors remote address parsing and test helpers.
  • Expands local and remote configuration tests.
Show a summary per file
File Description
src/config/file.ts Defines local and remote path prefixes.
src/config-utils.ts Routes prefixed paths and loads configurations.
src/config-utils.test.ts Tests local and remote path handling.
src/config/remote-file.ts Extracts new-format address parsing.
src/testing-utils.ts Exports a minimal assertion interface.
lib/entry-points.js Generated artifact; excluded from review.

Review details

Files excluded by content exclusion policy (1)
  • lib/entry-points.js
  • Files reviewed: 5/6 changed files
  • Comments generated: 4
  • Review effort level: Medium

Sorry, something went wrong.

Uh oh!

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

All reactions
Comment thread src/config-utils.ts Resolved

Uh oh!

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

Comment thread src/config/file.ts Resolved

Uh oh!

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

Comment thread src/config-utils.ts Resolved

Uh oh!

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

Comment thread src/config-utils.ts Resolved

Uh oh!

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

mbg added 3 commits July 15, 2026 16:11
@mbg
Fix typo in comment
abce648
@mbg
Rename helper functions
decb870
@mbg
Gate changes behind new format FF
247ce88
henrymercer
henrymercer previously approved these changes Jul 16, 2026
View reviewed changes

@henrymercer henrymercer 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.

Bike shed about the prefix, but otherwise LGTM!

Sorry, something went wrong.

Uh oh!

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

mbg reacted with heart emoji
All reactions
  • ❤️ 1 reaction
Comment thread src/config/file.ts Outdated
* are restricted to ASCII characters, '.', and '-'. The prefix chosen here does not interfere with
* those and is _unlikely_ (but not impossible) to appear in a local file path.
*/
export const REMOTE_PATH_PREFIX = "::";

@henrymercer henrymercer Jul 16, 2026

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.

What about something like remote:? It's five additional characters but can't be confused with two : separator characters.

Sorry, something went wrong.

Uh oh!

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

All reactions

@mbg mbg Jul 16, 2026

Copy link
Copy Markdown
Member Author

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.

I have no strong feelings on :: and am happy to change it to something else, but I don't think that remote: would be a good choice because, if you have a repo in your organisation named remote, e.g. remote:codeql.yml would be a valid remote file address that instructs us to fetch codeql.yml from org/remote, and a remote: prefix would clash with that and cause us to truncate it to just codeql.yml. That's why I think the prefix should start with a character that's not allowed in repo or org names.

Sorry, something went wrong.

Uh oh!

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

All reactions

@henrymercer henrymercer Jul 16, 2026

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.

Good point, how about remote=org/repo@ref:path or remote(org/repo@ref:path)?

Sorry, something went wrong.

Uh oh!

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

All reactions

@mbg mbg Jul 16, 2026

Copy link
Copy Markdown
Member Author

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.

I have changed the prefix to remote= in 3492b7e

Sorry, something went wrong.

Uh oh!

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

All reactions
@mbg mbg mentioned this pull request Jul 16, 2026
Fix new remote address being handled as local file by loadUserConfig #4012
Closed
mbg added 2 commits July 16, 2026 12:41
@mbg
Merge remote-tracking branch 'origin/main' into mbg/explicit-remote-p…
3654baa
…refix
@mbg
Change REMOTE_PATH_PREFIX to remote=
3492b7e
@mbg
mbg dismissed henrymercer’s stale review via 3492b7e July 16, 2026 11:44
@mbg
mbg requested review from Copilot and henrymercer and removed request for mario-campos July 16, 2026 11:45
henrymercer
henrymercer approved these changes Jul 16, 2026
View reviewed changes
Copilot started reviewing on behalf of mbg July 16, 2026 11:45
View session
Copilot AI reviewed Jul 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.

Review details

Files excluded by content exclusion policy (1)
  • lib/entry-points.js
  • Files reviewed: 5/6 changed files
  • Comments generated: 1
  • Review effort level: Medium

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.

@mbg
mbg enabled auto-merge July 16, 2026 11:50
@mbg
mbg added this pull request to the merge queue Jul 16, 2026
Merged via the queue into main with commit 9e7c070 Jul 16, 2026
227 checks passed

Uh oh!

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

@mbg
mbg deleted the mbg/explicit-remote-prefix branch July 16, 2026 12:11
This was referenced Jul 16, 2026
Merge main into releases/v4 #4020
Merged
Merge releases/v4 into releases/v3 #4022
Merged
@mario-campos mario-campos mentioned this pull request Jul 16, 2026
Use private registry proxy for API requests when available #4007
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
@henrymercer henrymercer henrymercer 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 @henrymercer
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.