Support shorthand forms for getRemoteConfig#3973
Open
mbg wants to merge 17 commits into
Open
Conversation
mbg
force-pushed
the
mbg/repo-props/config-file-shorthands
branch
from
a2218f1 to
12821cf
Compare
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
This PR extends remote configuration file support by enhancing getRemoteConfig to accept shorthand remote addresses (optional owner, path, and ref with sensible defaults), and refactors environment access to be more testable via an Env wrapper.
Changes:
- Added
parseRemoteFileAddress(and tests) to parse shorthand remote config references with defaults for owner/path/ref. - Moved
getRemoteConfigintosrc/config/file.tsand updated callers to use the new parsing logic. - Introduced
ActionsEnvVarsand anEnvabstraction to reduce raw string usage and improve testability.
Show a summary per file
| File | Description |
|---|---|
| src/util.ts | Adds Env accessor helpers and refactors env var getters. |
| src/testing-utils.ts | Adds getTestEnv() and tightens typing for default Actions env vars. |
| src/environment.ts | Introduces Env interface abstraction for environment access. |
| src/config/remote-file.ts | New parser for shorthand remote config references and defaults. |
| src/config/remote-file.test.ts | Unit tests for remote file address parsing and defaults. |
| src/config/file.ts | Adds getRemoteConfig() using parsed remote address components. |
| src/config-utils.ts | Switches to the new getRemoteConfig() implementation. |
| src/config-utils.test.ts | Removes a test that no longer matches the supported shorthand syntax. |
| src/api-client.ts | Replaces raw env var names with ActionsEnvVars. |
| src/actions-util.ts | Adds ActionsEnvVars enum and updates env var usages. |
| lib/entry-points.js | Changed but excluded from review (generated/contents unavailable). |
Copilot's findings
Files excluded by content exclusion policy (1)
- lib/entry-points.js
- Files reviewed: 10/11 changed files
- Comments generated: 6
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 a follow-up to #3963 which modifies
getRemoteConfigto accept shorthand addresses for remote files. Concretely, theowner,path, andrefcomponents are now optional and default to the owner of the current repo (as given byGITHUB_REPOSITORY),.github/codeql-action.yaml, andmainrespectively.Examples:
owner/reporesolves toowner/repo/.github/codeql-action.yaml@mainowner/repo@devresolves toowner/repo/.github/codeql-action.yaml@devowner/repo/.github/codeql/config.ymlresolves toowner/repo/.github/codeql/config.yml@mainNotes for reviewers
pathcomponentmainmay not always be the default branch for the target repo, but that's OK since it can be manually set to a different ref if needed.getRemoteConfigalready had a similar (but not equivalent) shorthand format. I then updated that instead so that the components other than the repo are optional. However, this isn't as nice, because/is used as a separator and can also appear in thepathcomponent. That means e.g. it is not possible with this format to specify a repo + path since it would be interpreted as owner + repo by the regex instead.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