Skip to content

document incremental build cache in builder docs #522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
js-9 wants to merge 5 commits into
base: main
Choose a base branch
from
Open

document incremental build cache in builder docs #522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c0ffa39
document incremental build cache in builder docs
js-9 Oct 21, 2025
8b2a548
AI caught mistake
js-9 Oct 21, 2025
3a0e9f5
reformat with prettier
js-9 Dec 6, 2025
9accdde
capitalize IL2CPP
js-9 Dec 6, 2025
2589931
Merge branch 'main' into patch-1
frostebite May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/03-github/03-test-runner.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,25 @@ This simple addition could speed up your test runs by more than 50%.
Note that caching in this manner only applies to testing Unity **Projects**, not Unity **Packages**
(see [Caveats](#caveats)).

### Incremental build cache

To further speed up consequent builds, you may want to cache the incremental build cache directory.

Example:

```yaml
- uses: actions/cache@v3
with:
path: ~/work/_temp/_github_home/.cache/unity3d/bee
key: IncrementalBuildCache-MyProjectName-TargetPlatform
restore-keys: |
IncrementalBuildCache-MyProjectName-
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.

## Configuration options

Below options can be specified under `with:` for the `unity-test-runner` action.
Expand Down
21 changes: 21 additions & 0 deletions docs/03-github/04-builder.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ Builds can now be downloaded as Artifacts in the Actions tab.

## Caching

### Library cache

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.
Expand All @@ -127,6 +129,25 @@ Example:

This simple addition could speed up your build by more than 50%.

### Incremental build cache

To further speed up consequent builds, you may want to cache the incremental build cache directory.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 8, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use “subsequent” (or “consecutive”) instead of “consequent”.

Line 134 reads awkwardly in user-facing docs; a quick wording fix would improve clarity.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/03-github/04-builder.mdx` at line 134, Replace the awkward word
"consequent" in the sentence "To further speed up consequent builds, you may
want to cache the incremental build cache directory." with "subsequent" (or
"consecutive") so it reads "To further speed up subsequent builds, you may want
to cache the incremental build cache directory."; update the single sentence in
docs/03-github/04-builder.mdx where the phrase "consequent builds" appears.


Example:

```yaml
- uses: actions/cache@v3
with:
path: ~/work/_temp/_github_home/.cache/unity3d/bee
key: IncrementalBuildCache-MyProjectName-TargetPlatform
restore-keys: |
IncrementalBuildCache-MyProjectName-
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.

## Configuration options

Below options can be specified under `with:` for the `unity-builder` action.
Expand Down