Add support for an explicit remote path prefix#4014
Open
mbg wants to merge 10 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
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
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.
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. I have somewhat arbitrarily chosen
::for this since it is short and unlikely to clash with anything.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
dynamicworkflows (Default Setup, Code Quality, ...).Products:
analysis-kinds: code-scanning.analysis-kinds: code-quality.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