GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Include primary cache keys as restore key by mbg · Pull Request #4206 · github/codeql-action

Conversation

@mbg

@mbg mbg commented Oct 7, 2026

Copy link
Copy Markdown
Member

See #4202 for context. Apparently some third-party systems don't use the primary cache key that's used for cache restores as a restore key if it's not also included separately as a restore key. This PR changes our restoreCache calls so that the primary restore key is also always included as a restore key. This should not make a difference on first-party systems.

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.
  • Code Quality - The changes impact analyses when analysis-kinds: code-quality.
  • Other first-party - The changes impact other first-party analyses.

Environments:

Third-party runner 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).
  • End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

  • Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

  • Telemetry - I rely on existing telemetry or have made changes to the telemetry.
    • Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release.

Are there any special considerations for merging or releasing this change?

  • No special considerations - This change can be merged at any time.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@mbg
Include primary cache keys as restore key
4f73d1a
@github-actions github-actions Bot added the size/XS Should be very easy to review label Oct 7, 2026
@mbg
Merge branch 'main' into mbg/set-restore-keys
0993337
@mbg
mbg marked this pull request as ready for review October 12, 2026 15:26
@mbg
mbg requested a review from a team as a code owner October 12, 2026 15:26
Copilot AI balanced review requested due to automatic review settings October 12, 2026 15:26
Copilot started reviewing on behalf of mbg October 12, 2026 15:27
View session
Copilot AI reviewed Oct 12, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

🟡 Changes recommended

The backend-compatibility behavior lacks regression assertions in the existing unit tests.

4 open findings
  • Low severity Test primaryKey inclusion in dependency restoreKeys · New
  • Low severity Assert restoreCache uses cacheRestoreKeyPrefix · New
  • Low severity Assert restoreCache receives cacheKey as restore key · New
  • Low severity Add regression test for preferredKey in restoreKeys · New
What changed in this PR

Adds primary cache keys to restore-key lists for compatibility with third-party cache backends that only prefix-match restore keys.

Changes:

  • Updates dependency, TRAP, and overlay cache restoration.
  • Applies the behavior consistently across source call sites.
File Description
src/​trap-caching.ts Adds the preferred key to restore keys.
src/​dependency-caching.ts Adds the primary dependency key to restore keys.
src/​overlay/​status.ts Adds the status key to restore keys.
src/​overlay/​caching.ts Fixes overlay-base restoration on affected backends.
lib/​entry-points.js Excluded generated file; not reviewed.
Files excluded by content exclusion policy (1)
  • lib/entry-points.js

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread src/dependency-caching.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/overlay/caching.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/overlay/status.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/trap-caching.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.

@mbg

mbg commented Oct 14, 2026

Copy link
Copy Markdown
Member Author

I won't extend test coverage for this change as Copilot requested, since it concerns a third-party behaviour. The existing tests model the correct behaviour and as long as they continue to pass with this change, I am happy.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

mario-campos
mario-campos approved these changes Oct 14, 2026
View reviewed changes
@mbg
mbg added this pull request to the merge queue Oct 14, 2026
Merged via the queue into main with commit f460dc7 Oct 14, 2026
265 of 267 checks passed

Uh oh!

There was an error while loading. Please reload this page.

@mbg
mbg deleted the mbg/set-restore-keys branch October 14, 2026 14:58
github-merge-queue Bot pushed a commit that referenced this pull request Oct 14, 2026
@mbg
Add change note for #4206
a897ed5
This was referenced Oct 15, 2026
Merge main into releases/v4 #4239
Merged
Merge releases/v4 into releases/v3 #4241
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@mario-campos mario-campos mario-campos approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

size/XS Should be very easy to review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@mbg @mario-campos
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.