Update caching docs for canonical-overlay removal - #578
Merged
Merged
Conversation
Replaces the "Canonical Cache + Overlay (Advanced)" section with a short removed-feature note pointing to game-ci/orchestrator#40 and game-ci/roadmap#11, and corrects the inputs reference table to drop the now-removed canonicalCache* / cacheMaterialize / cacheSentinelCanary inputs. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe documentation removes canonical-overlay caching details and updates ChangesLocal cache documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Mergeability Score: ⚪ Minimal · up to The documentation removes references to the retired cache mode and updates the remaining cache guidance and links; no actionable merge-blocking risk remains beyond normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
|
Follow-up to the earlier canonical-overlay removal commit, now that game-ci/orchestrator#41 has landed switching the default localCacheMode from tar to move-directory: - build-services.mdx: updates the Cache Mode table and Inputs table to show move-directory as default, and notes the new automatic EXDEV copy fallback for cross-volume setups. - caching.mdx: corrects the removal note (previously said tar was still the default) and updates the roadmap#11 follow-up summary to drop the now-completed default-switch item. - Also removes an orphaned cacheSentinelCanary table row left over from the canonical-overlay removal edit, and restores a missing blank line before a heading. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
- caching.mdx linked to a relative path (05-hooks/05-built-in-hooks) that Docusaurus didn't resolve the way a plain markdown relative link normally would, breaking the build (docusaurus found broken links). Fixed to the correct absolute path, /docs/github-orchestrator/advanced-topics/hooks/built-in-hooks, verified against the live site. - Ran oxfmt on both files touched by the earlier canonical-overlay- removal edits, which had been hand-edited via a script and didn't match the project's formatting. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Visit the preview URL for this PR (updated for commit ac4ff82): https://game-ci-5559f--pr578-remove-canonical-ove-kogelnp3.web.app (expires Sat, 22 Aug 2026 02:10:30 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 1f0574f15f83e11bfc148eae8646486a6d0e078b |
It was experimental and never should have left a paper trail once removed. Deletes the entire "Canonical Cache + Overlay (Removed)" explanatory section outright instead of keeping a summary of what it used to be, and drops the dangling "(canonical-overlay removed, see above)" parenthetical from the inputs table now that there's no "above" to point to. The only thing that stays is the runtime guard in orchestrator (plugin-lifecycle.ts) that throws a clear error if someone still has localCacheMode: canonical-overlay configured - removing that too would make it silently behave like move-directory instead, which is worse. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
frostebite
marked this pull request as ready for review
August 13, 2026 01:08
frostebite
enabled auto-merge (squash)
August 13, 2026 01:09
webbertakken
approved these changes
Aug 14, 2026
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
2 participants
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.
Companion docs PR for game-ci/orchestrator#40, which removes the
canonical-overlaylocal cache mode entirely.localCacheMode: canonical-overlayset will hit the runtime error added in orchestrator#40, which is self-explanatory.canonicalCacheRoot,canonicalCacheClassifier,canonicalCacheVersionRetention,cacheMaterialize,cacheSentinelCanary(all removed alongside the feature), and updates thelocalCacheModerow to only list the three modes that remain (move-directory,copy-directory,tar).10-build-services.mdxupdated to reflectmove-directoryas the new default cache mode (orchestrator#41).05-hooks/05-built-in-hooks→ absolute/docs/github-orchestrator/advanced-topics/hooks/built-in-hooks) and an oxfmt formatting issue.Verified: zero remaining references to "canonical" anywhere in either changed file.
Summary by CodeRabbit
canonical-overlaycaching mode.move-directory.