Reduce the minimum Git version required for overlay#3767
Open
henrymercer wants to merge 3 commits intomainfrom
Open
Reduce the minimum Git version required for overlay#3767henrymercer wants to merge 3 commits intomainfrom
henrymercer wants to merge 3 commits intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR lowers the minimum Git version needed for overlay (improved incremental) analysis by changing how tracked file OIDs are gathered from Git, improving compatibility with older runner images/environments.
Changes:
- Switch
getFileOidsUnderPathfromgit ls-files --format=...(Git ≥2.38) togit ls-files --stage(compatible with Git ≥2.11 when combined with--recurse-submodules). - Update unit tests to reflect the new
--stageoutput format and parsing. - Add a changelog entry documenting the reduced minimum Git requirement.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/git-utils.ts | Lowers the overlay minimum Git version and updates getFileOidsUnderPath to parse git ls-files --stage output. |
| src/git-utils.test.ts | Updates/extends tests to validate parsing of --stage output, including quoted/escaped paths. |
| src/config-utils.test.ts | Adjusts the “old git version” fallback test to reflect the new 2.11.0 minimum. |
| CHANGELOG.md | Documents the reduced minimum Git version for improved incremental analysis. |
| lib/upload-sarif-action.js | Generated JS update reflecting the TypeScript change. |
| lib/upload-lib.js | Generated JS update reflecting the TypeScript change. |
| lib/setup-codeql-action.js | Generated JS update reflecting the TypeScript change. |
| lib/resolve-environment-action.js | Generated JS update reflecting the TypeScript change. |
| lib/init-action.js | Generated JS update reflecting the TypeScript change (including minimum version constant). |
| lib/init-action-post.js | Generated JS update reflecting the TypeScript change. |
| lib/autobuild-action.js | Generated JS update reflecting the TypeScript change. |
| lib/analyze-action.js | Generated JS update reflecting the TypeScript change. |
| lib/analyze-action-post.js | Generated JS update reflecting the TypeScript change. |
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.
Use the
--stageoption forgit ls-filesinstead of--formatto reduce the minimum Git version for overlay from 2.38.0 (released October 2022) to 2.11.0 (released November 2016).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.Environments:
github.comand/or GitHub Enterprise Cloud with Data Residency.How did/will you validate this change?
.test.tsfiles).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