document incremental build cache in builder docs #522
Conversation
|
|
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughAdds documentation subsections describing caching of the Unity Library folder and the incremental build cache, including GitHub Actions YAML examples, notes about Windows runner path differences, and guidance that the incremental cache is stored alongside the Library folder. 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.
davidmfinol
left a comment
davidmfinol
left a comment
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.
Head branch was pushed to by a user without write access
Oh wow! Sorry man, I totally missed your reply. Updated with change from game-ci/unity-test-runner#300 as well, and prettier run. |
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/03-github/04-builder.mdx (1)
148-148: Capitalize "IL2CPP" for technical consistency.Line 148 should use "IL2CPP" (all caps) to match Unity's official naming convention and be consistent with how it appears elsewhere in technical documentation.
-On a Windows runner (e.g. if building for il2cpp) this path is different, but the incremental build +On a Windows runner (e.g. if building for IL2CPP) this path is different, but the incremental build
🧹 Nitpick comments (1)
docs/03-github/04-builder.mdx (1)
114-116: Simplify verbose phrasing."In order to" can be shortened to "To" for more concise documentation.
-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) +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)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/03-github/03-test-runner.mdx(1 hunks)docs/03-github/04-builder.mdx(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/03-github/03-test-runner.mdx
🧰 Additional context used
🪛 LanguageTool
docs/03-github/04-builder.mdx
[style] ~113-~113: Consider a more concise word here.
Context: ...ns 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)
141-141: No changes needed — tilde expansion is officially supported and tested in GitHub Actions.The path
~/work/_temp/_github_home/.cache/unity3d/beeis correct. GitHub Actionsactions/cache@v3officially documents and supports tilde (~) expansion to the runner HOME directory across all runner types (Ubuntu, Windows, macOS). The v3 release notes include fixes for~/path handling on ubuntu-latest, confirming it has been tested and is reliable. Using tilde is the recommended approach; explicit${{ env.HOME }}expansion is unnecessary.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/03-github/04-builder.mdx (2)
113-114: Simplify "In order to" for conciseness.Shorten "In order to make builds run faster" to "To make builds run faster" for a more direct, concise opening.
-In order to make builds run faster, you can cache Library files from previous builds. To do so +To make builds run faster, you can cache Library files from previous builds. To do so
134-134: Use "consecutive" or "subsequent" instead of "consequent" for clarity.The phrase "consequent builds" is technically valid but unconventional for this context. "Consecutive builds" or "subsequent builds" would be clearer and more idiomatic when referring to builds that follow one another.
-To further speed up consequent builds, you may want to cache the incremental build cache directory. +To further speed up consecutive builds, you may want to cache the incremental build cache directory.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/03-github/03-test-runner.mdx(1 hunks)docs/03-github/04-builder.mdx(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/03-github/03-test-runner.mdx
🧰 Additional context used
🪛 LanguageTool
docs/03-github/04-builder.mdx
[style] ~113-~113: Consider a more concise word here.
Context: ...ns 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)
141-141: Cache path syntax is correct.The use of the tilde (
~) in the cache path is appropriate and correctly resolves the previous critical issue about shell variable expansion in GitHub Actions. The path will be properly expanded by the cache action.
3 participants
Changes
Checklist
code of conduct
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.