document incremental build cache in builder docs #522
Conversation
|
|
WalkthroughAdds two documentation subsections under Caching: "Library cache" with guidance and YAML examples for caching the Unity Library folder using actions/cache, and "Incremental build cache" with example config and platform-specific path notes (Windows path differences; incremental cache stored alongside Library). Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/03-github/04-builder.mdx (2)
113-113: Consider condensing "In order to" for better readability.Replace "In order to make builds run faster, you can cache Library files from previous builds. To do so simply add Github Actions official" with "To make builds run faster, you can cache Library files from previous builds. Simply add Github Actions official" for more concise phrasing.
-In order to make builds run faster, you can cache Library files from previous builds. To do so -simply add Github Actions official [cache action](https://github.com/marketplace/actions/cache) -before any unity steps. +To make builds run faster, you can cache Library files from previous builds. Simply add Github Actions official [cache action](https://github.com/marketplace/actions/cache) +before any unity steps.
131-146: Documentation addition looks good, but consider expanding Windows guidance.The new incremental build cache documentation is well-structured and includes helpful notes. However, line 146 mentions that "on Windows runners the path is different" but doesn't show an example or clarification of what that path would be. Consider adding a brief note or example for Windows users to avoid confusion.
For example, you might add a small note like:
+On Windows runners (e.g., il2cpp builds), the bee cache path differs but is still saved alongside the Library folder. Consider using a platform-agnostic pattern or absolute paths that work across runners.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/03-github/04-builder.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/03-github/04-builder.mdx
[style] ~112-~112: Consider a more concise word here.
Context: ...ons tab. ## Caching ### Library cache In order to make builds run faster, you can cache L...
(IN_ORDER_TO_PREMIUM)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/03-github/04-builder.mdx (1)
137-144: Verify the cache path syntax for GitHub Actions compatibility.The cache path at line 139 uses
~/work/_temp/_github_home/.cache/unity3d/bee, which relies on shell tilde expansion. GitHub Actionscache@v3may not reliably expand~in the path field since the cache action does not execute within a shell context. Previous review flagged this concern with$HOMEsyntax; tilde (~) has the same limitation.For maximum compatibility, consider using a workspace-relative path or GitHub Actions environment variables. You may want to verify this path works consistently across all runner types and document any caveats.
Please confirm whether
~/work/_temp/_github_home/.cache/unity3d/beeis reliably resolved byactions/cache@v3on all runner types, or provide the equivalent GitHub Actions expression syntax (e.g.,${{ env.HOME }}/work/_temp/_github_home/.cache/unity3d/bee).
🧹 Nitpick comments (1)
docs/03-github/04-builder.mdx (1)
113-113: Minor style improvement: use "To" instead of "In order to".The phrase "In order to make builds run faster" can be more concise as "To make builds run faster".
Apply this diff:
- In order to make builds run faster, you can cache Library files from previous builds. To do so - simply add Github Actions official [cache action](https://github.marketplace/actions/cache) + To make builds run faster, you can cache Library files from previous builds. To do so + simply add Github Actions official [cache action](https://github.marketplace/actions/cache)Based on static analysis hint from LanguageTool.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/03-github/04-builder.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/03-github/04-builder.mdx
[style] ~112-~112: Consider a more concise word here.
Context: ...ons tab. ## Caching ### Library cache In order to make builds run faster, you can cache L...
(IN_ORDER_TO_PREMIUM)
🔇 Additional comments (1)
docs/03-github/04-builder.mdx (1)
146-146: Clarify the Windows incremental cache path.Line 146 states "on a windows runner... this path is different, but the incremental build cache is automatically saved with the Library folder" but provides no explicit alternative path for Windows users. This leaves Windows developers uncertain about where to find or cache the incremental build artifacts.
Please provide:
- The actual incremental cache path on Windows runners (e.g., something like
~\AppData\Local\Temp\...or similar).- Clarification on whether Windows users should cache the same
pathdirective or if a conditional/platform-specific approach is needed.Alternatively, if the Windows path is identical to the Linux path (just different file separators), make that explicit.
There was a problem hiding this comment.
Pull Request Overview
This PR documents how to use incremental build caching in Unity Builder to improve build performance beyond the basic library cache. It adds guidance on configuring the incremental build cache, including platform-specific considerations for Windows runners.
- Splits the existing caching section into two subsections: Library cache and Incremental build cache
- Adds example configuration for caching the incremental build cache directory on non-Windows runners
- Documents that Windows runners automatically cache incremental builds with the Library folder
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| This simple addition could speed up your build by more than 50%. | ||
|
|
||
| ### Incremental build cache | ||
| To further speedup consequent builds, you may want to cache the incremental build cache directory. |
There was a problem hiding this comment.
Corrected spelling of 'speedup' to 'speed up' (two words when used as a verb).
| To further speedup consequent builds, you may want to cache the incremental build cache directory. | |
| To further speed up consequent builds, you may want to cache the incremental build cache directory. |
| IncrementalBuildCache- | ||
| ``` | ||
|
|
||
| On a windows runner (e.g. if building for il2cpp) this path is different, but the incremental build cache is automatically saved with the Library folder. |
There was a problem hiding this comment.
Capitalize 'Windows' and 'IL2CPP' for consistency with technical naming conventions.
| On a windows runner (e.g. if building for il2cpp) this path is different, but the incremental build cache is automatically saved with the Library folder. | |
| On a Windows runner (e.g. if building for IL2CPP) this path is different, but the incremental build cache is automatically saved with the Library folder. |
There was a problem hiding this comment.
@js-9 Can you run prettier to fix the formatting? The Copilot suggestions are also valid, I think. We should be able to merge once you've updated.
3 participants
Changes
Checklist
code of conduct
Summary by CodeRabbit