Title: Determine the overlay minimum disk space requirement from feature flags by henrymercer · Pull Request #4080 · github/codeql-action · GitHub
Open Graph Title: Determine the overlay minimum disk space requirement from feature flags by henrymercer · Pull Request #4080 · github/codeql-action
X Title: Determine the overlay minimum disk space requirement from feature flags by henrymercer · Pull Request #4080 · github/codeql-action
Description: Overlay analysis skips runners that don't have enough free disk space. Until now that threshold was a single hard-coded value with one flag-gated alternative: 20 GB normally, or 14 GB when overlay_analysis_resource_checks_v2 was enabled. That gave us exactly one step to roll out, and reaching a lower limit meant another flag and another release. This replaces that with a set of flags that each name a threshold, so we can tune the requirement without shipping code: overlay_analysis_min_disk_8_gb overlay_analysis_min_disk_9_gb overlay_analysis_min_disk_10_gb overlay_analysis_min_disk_11_gb overlay_analysis_min_disk_12_gb overlay_analysis_min_disk_13_gb When several are enabled the lowest threshold wins, so we can roll a lower limit out to a subset of repositories without having to disable the flag above it first. When none are enabled the default of 14 GB applies. overlay_analysis_resource_checks_v2 is removed and its 14 GB value becomes the unconditional baseline, so the 20 GB limit is gone. Note that this part is not itself behind a flag — anyone previously on the 20 GB path moves to 14 GB when this ships. On GHES that only affects users who have explicitly opted into overlay analysis via CODEQL_ACTION_OVERLAY_ANALYSIS, since overlay_analysis defaults to off there. Anyone setting CODEQL_ACTION_OVERLAY_ANALYSIS_RESOURCE_CHECKS_V2 will find it no longer has any effect. Thresholds stay in decimal MB (N * 1000 MB), matching the existing bytes-per-MB convention in the disk check, so the effective byte values are unchanged from the previous 14 GB path. The check also now logs the available and required space at debug level when it passes, so it's possible to tell from a run log which flag took effect. Risk assessment For internal use only. Please select the risk level of this change: Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only. Which use cases does this change impact? Workflow types: Advanced setup - Impacts users who have custom CodeQL workflows. Managed - Impacts users with dynamic workflows (Default Setup, Code Quality, ...). Products: Code Scanning - The changes impact analyses when analysis-kinds: code-scanning. Environments: Dotcom - Impacts CodeQL workflows on github.com and/or GitHub Enterprise Cloud with Data Residency. GHES - Impacts CodeQL workflows on GitHub Enterprise Server. How did/will you validate this change? Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files). If something goes wrong after this change is released, what are the mitigation and rollback strategies? Feature flags - Lowering the threshold below the 14 GB default is fully controlled by the new feature flags and can be reverted by disabling them. Rollback - The change of the default threshold from 20 GB to 14 GB is not behind a feature flag, and would need a rollback or a follow-up release to revert. Overlay analysis as a whole can still be disabled via the overlay_analysis feature flag, the CODEQL_OVERLAY_DATABASE_MODE environment variable, or the disable-overlay repository property. How will you know if something goes wrong after this change is released? Telemetry - I rely on existing telemetry. Dashboards - I will watch relevant dashboards for issues after the release. Are there any special considerations for merging or releasing this change? Special considerations - The six new feature flags need to exist before this is released, otherwise the threshold stays at the 14 GB default. Merge / deployment checklist Confirm this change is backwards compatible with existing workflows. Consider adding a changelog entry for this change. Confirm the readme and docs have been updated if necessary.
Open Graph Description: Overlay analysis skips runners that don't have enough free disk space. Until now that threshold was a single hard-coded value with one flag-gated alternative: 20 GB normally, or 14 GB when over...
X Description: Overlay analysis skips runners that don't have enough free disk space. Until now that threshold was a single hard-coded value with one flag-gated alternative: 20 GB normally, or 14 GB when ...
Opengraph URL: https://github.com/github/codeql-action/pull/4080
X: @github
Domain: github.com
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf |
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:d8ceaac5-114b-c1d2-664a-65de6612d91a |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | B5A4:D9695:618207:7ED8D2:6AED2BC5 |
| html-safe-nonce | bc0ef0fb28b96c3f0ab731523ffcef4d6784b9e7c831891929c59c95eb81150d |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCNUE0OkQ5Njk1OjYxODIwNzo3RUQ4RDI6NkFFRDJCQzUiLCJ2aXNpdG9yX2lkIjoiNzI0ODA2NTMyMjA0NDA3NzQ5IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 5302ac227262d477aa7720e0bbeb606fbb47f846f52cfc28648e72a8bdbb2016 |
| hovercard-subject-tag | pull_request:4222258622 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/github/codeql-action/pull/4080/files |
| twitter:image | https://avatars.githubusercontent.com/u/14129055?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/14129055?s=400&v=4 |
| og:image:alt | Overlay analysis skips runners that don't have enough free disk space. Until now that threshold was a single hard-coded value with one flag-gated alternative: 20 GB normally, or 14 GB when over... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 9d95365dda0576efe9b71f45807595e396bd0ca9286fba5367a05048e6ddf8f2 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/github/codeql-action git https://github.com/github/codeql-action.git |
| octolytics-dimension-user_id | 9919 |
| octolytics-dimension-user_login | github |
| octolytics-dimension-repository_id | 259445878 |
| octolytics-dimension-repository_nwo | github/codeql-action |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 259445878 |
| octolytics-dimension-repository_network_root_nwo | github/codeql-action |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 98b41fa4b5635ceb45a4c54320fced73817ff290 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width