getFileDiffsWithBasehead(): use CODE_SCANNING_REPOSITORY if present - #2830
cklin merged 4 commits into
Conversation
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
This PR updates the repository name resolution in various modules to allow an override via the CODE_SCANNING_REPOSITORY environment variable, making the functions more flexible in determining the repository context for code scanning operations.
- Replace all usages of parseRepositoryNwo with getRepositoryNwo (or getRepositoryNwoFromEnv) to support the new override.
- Update functions across core modules (src, lib folders) to use the new repository resolution functions.
Reviewed Changes
Copilot reviewed 33 out of 33 changed files in this pull request and generated no comments.
Show a summary per file| File | Description |
|---|---|
| src/status-report.ts | Updated repository info retrieval using getRepositoryNwo |
| src/repository.ts | Introduced getRepositoryNwo and getRepositoryNwoFromEnv functions |
| src/init-action*.ts | Replaced parseRepositoryNwo with getRepositoryNwo |
| src/autobuild.ts | Similar repository resolution update |
| src/api-client.ts | Updated repository usage in API requests |
| src/analyze*.ts | Updated getFileDiffsWithBasehead to consider CODE_SCANNING_REPOSITORY |
| lib/* | Consistent update of repository function calls throughout |
src/analyze.ts:393
- It appears there is no test coverage for the conditional logic in getRepositoryNwoFromEnv (i.e. when CODE_SCANNING_REPOSITORY is set versus when it is not). Consider adding tests to ensure both scenarios are properly handled.
const repositoryNwo = getRepositoryNwoFromEnv("CODE_SCANNING_REPOSITORY", "GITHUB_REPOSITORY");
Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more
Sorry, something went wrong.
angelapwen
left a comment
There was a problem hiding this comment.
Makes sense!! Just a small comment about documentation 😸
Sorry, something went wrong.
| ): Promise<FileDiff[] | undefined> { | ||
| const repositoryNwo = getRepositoryNwo(); | ||
| const repositoryNwo = getRepositoryNwoFromEnv( | ||
| "CODE_SCANNING_REPOSITORY", |
There was a problem hiding this comment.
Perhaps a small code comment here indicating that CODE_SCANNING_REPOSITORY is intended to override GITHUB_REPOSITORY would be useful for other maintainers!
Sorry, something went wrong.
There was a problem hiding this comment.
Thanks for the suggestion! I added the comment.
Sorry, something went wrong.
This PR updates getFileDiffsWithBasehead() so that it uses CODE_SCANNING_REPOSITORY if present, which makes it possible to override the repository that contains the commits being analized.
The PR also introduces a getRepositoryNwo() helper function that reduces code duplication across the codebase.
Merge / deployment checklist