Documentation improvements (#132)

- Add `RELEASING.md` to document the release process
- Mention the recommendation to disable local build-cache when remote
build-cache is available. Fixes #102
This commit is contained in:
Daz DeBoer
2024-04-08 19:19:50 -06:00
committed by GitHub
parent 8ffe734df6
commit 6232a3f503
2 changed files with 59 additions and 0 deletions

View File

@@ -363,6 +363,17 @@ Gradle Home cache cleanup is considered experimental and is disabled by default.
```yaml
gradle-home-cache-cleanup: true
```
### Disable local build-cache when remote build-cache is available
If you have a remote build-cache available for your build, then it is recommended to do the following:
- Enable [remote build-cache push](https://docs.gradle.org/current/userguide/build_cache.html#sec:build_cache_configure_use_cases) for your GitHub Actions builds
- Disable [local build-cache]() for your GitHub Actions build
As well as reducing the content that needs to be saved to the GitHub Actions cache,
this setup will ensure that your CI builds populate the remote cache and keep the cache entries fresh by reading these entries.
Local builds can then benefit from the remote cache.
## Debugging and Troubleshooting
To debug a failed job, it can be useful to run with [debug logging enabled](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging).