From 7f46dbd76f57c52a39d6ae9582828937129d0a3a Mon Sep 17 00:00:00 2001 From: Daz DeBoer Date: Mon, 20 Jun 2022 20:45:24 -0600 Subject: [PATCH] Document support for GitHub Enterprise Server --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5dc1eba..eeab134 100644 --- a/README.md +++ b/README.md @@ -258,7 +258,7 @@ File pattern support is documented at https://docs.github.com/en/actions/learn-g Gradle User Home state will be restored from the cache during the first `gradle-build-action` step for any workflow job. This state will be saved back to the cache at the end of the job, after all Gradle executions have completed. -A report of all cache entries restored and saved is printed to the action log when saving the cache entries. +A report of all cache entries restored and saved is printed to the Job Summary when saving the cache entries. This report can provide valuable insignt into how much cache space is being used. It is possible to enable additional debug logging for cache operations. You do via the `GRADLE_BUILD_ACTION_CACHE_DEBUG_ENABLED` environment variable: @@ -361,3 +361,9 @@ jobs: body: '❌ ${{ github.workflow }} failed: ${{ steps.gradle.outputs.build-scan-url }}' }) ``` + +## Support for GitHub Enterprise Server (GHES) + +You can use the `gradle-build-action` on GitHub Enterprise Server, with some important limitations: +- Support for GitHub Actions cache was introduced in GHES v3.5. Workflows using `gradle-build-action` on an earlier version of GHES will not benefit from save/restore of Gradle User Home. +- Support for GitHub Actions Job Summary is not yet available in any version of GHES. Instead of producing a Job Summary, the build-results summary and caching report will be written to the workflow log, as part of the post-action step.