diff --git a/docs/03-github/03-test-runner.mdx b/docs/03-github/03-test-runner.mdx index 021776aa..5a381ade 100644 --- a/docs/03-github/03-test-runner.mdx +++ b/docs/03-github/03-test-runner.mdx @@ -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. diff --git a/docs/03-github/04-builder.mdx b/docs/03-github/04-builder.mdx index 85efb118..f37664e2 100644 --- a/docs/03-github/04-builder.mdx +++ b/docs/03-github/04-builder.mdx @@ -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. @@ -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. + +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.