Skip overlay memory check for CodeQL 2.24.3 and later#3515
Open
henrymercer wants to merge 1 commit intohenrymercer/overlay-repo-propertyfrom
Open
Skip overlay memory check for CodeQL 2.24.3 and later#3515henrymercer wants to merge 1 commit intohenrymercer/overlay-repo-propertyfrom
henrymercer wants to merge 1 commit intohenrymercer/overlay-repo-propertyfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates overlay analysis resource checking so that the minimum-memory gating is skipped for CodeQL CLI versions where overlay no longer increases peak RAM usage (2.24.3+).
Changes:
- Introduce a CodeQL version threshold (2.24.3) after which overlay’s minimum-memory check is skipped.
- Refactor overlay resource checks into separate disk-space and memory helpers, with additional debug logging.
- Add regression tests asserting overlay remains enabled on low-memory settings when CodeQL >= 2.24.3.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/config-utils.ts | Skips overlay minimum-memory check for CodeQL >= 2.24.3 and refactors disk/memory resource checks. |
| src/config-utils.test.ts | Adds test cases for the new version-gated memory-check behavior on default branch and PR runs. |
| lib/init-action.js | Generated JS update corresponding to the TypeScript changes (not reviewed). |
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.
RAM usage with overlay analysis enabled should generally be no higher than it is without overlay analysis for these versions.
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?
These changes will be validated as part of the next release process.
If something goes wrong after this change is released, what are the mitigation and rollback strategies?
Disable via broader overlay feature flags, or CodeQL version feature flags.
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