Update README.md for changes in release

With Gradle 8.1, the configuration-cache has changed and is now stable. 
As a temporary measure, this commit disables save/restore of the configuration-cache
data to avoid issues until we can deal with this change properly.

.github/dependabot.yml

@@ -6,11 +6,14 @@ registries:
     username: dummy # Required by dependabot
     password: dummy # Required by dependabot
 updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
   - package-ecosystem: "npm"
     directory: "/"
     schedule:
       interval: "weekly"
-    open-pull-requests-limit: 10
     ignore:
       - dependency-name: "@types/node"
   - package-ecosystem: "gradle"

.github/workflow-samples/gradle-plugin/gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=1b6b558be93f29438d3df94b7dfee02e794b94d9aca4611a92cdb79b6b88e909
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.1-bin.zip
+distributionSha256Sum=ff7bf6a86f09b9b2c40bb8f48b25fc19cf2b2664fd1d220cd7ab833ec758d0d7
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

.github/workflow-samples/groovy-dsl/gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=1b6b558be93f29438d3df94b7dfee02e794b94d9aca4611a92cdb79b6b88e909
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.1-bin.zip
+distributionSha256Sum=ff7bf6a86f09b9b2c40bb8f48b25fc19cf2b2664fd1d220cd7ab833ec758d0d7
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

.github/workflow-samples/groovy-dsl/settings.gradle

@@ -1,6 +1,6 @@
 plugins {
-    id "com.gradle.enterprise" version "3.12.3"
-    id "com.gradle.common-custom-user-data-gradle-plugin" version "1.8.2"
+    id "com.gradle.enterprise" version "3.12.6"
+    id "com.gradle.common-custom-user-data-gradle-plugin" version "1.10"
 }
 
 gradleEnterprise {

.github/workflow-samples/java-toolchain/gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=1b6b558be93f29438d3df94b7dfee02e794b94d9aca4611a92cdb79b6b88e909
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.1-bin.zip
+distributionSha256Sum=ff7bf6a86f09b9b2c40bb8f48b25fc19cf2b2664fd1d220cd7ab833ec758d0d7
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

.github/workflow-samples/kotlin-dsl/gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=1b6b558be93f29438d3df94b7dfee02e794b94d9aca4611a92cdb79b6b88e909
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.1-bin.zip
+distributionSha256Sum=ff7bf6a86f09b9b2c40bb8f48b25fc19cf2b2664fd1d220cd7ab833ec758d0d7
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

.github/workflow-samples/kotlin-dsl/settings.gradle.kts

@@ -1,6 +1,6 @@
 plugins {
-    id("com.gradle.enterprise") version "3.12.3"
-    id("com.gradle.common-custom-user-data-gradle-plugin") version "1.8.2"
+    id("com.gradle.enterprise") version "3.12.6"
+    id("com.gradle.common-custom-user-data-gradle-plugin") version "1.10"
 }
 
 gradleEnterprise {

.github/workflow-samples/no-wrapper-gradle-5/build.gradle

@@ -1,5 +1,5 @@
 plugins {
-    id "com.gradle.build-scan" version "3.12.3" 
+    id "com.gradle.build-scan" version "3.12.6" 
 }
 
 gradleEnterprise {

.github/workflow-samples/no-wrapper/settings.gradle

@@ -1,5 +1,5 @@
 plugins {
-    id "com.gradle.enterprise" version "3.12.3"
+    id "com.gradle.enterprise" version "3.12.6"
 }
 
 gradleEnterprise {

.github/workflows/ci-dependency-review.yml

@@ -17,4 +17,4 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v2
+        uses: actions/dependency-review-action@v3

.github/workflows/ci-full-check.yml

@@ -44,10 +44,10 @@ jobs:
     with:
       cache-key-prefix: ${{github.run_number}}-
 
-  restore-configuration-cache:
-    uses: ./.github/workflows/integ-test-restore-configuration-cache.yml
-    with:
-      cache-key-prefix: ${{github.run_number}}-
+  # restore-configuration-cache:
+  #   uses: ./.github/workflows/integ-test-restore-configuration-cache.yml
+  #   with:
+  #     cache-key-prefix: ${{github.run_number}}-
 
   restore-custom-gradle-home:
     uses: ./.github/workflows/integ-test-restore-custom-gradle-home.yml

.github/workflows/ci-quick-check.yml

@@ -22,7 +22,7 @@ jobs:
     - name: Configure Gradle as default for unit test
       uses: ./
       with:
-        gradle-version: 7.6
+        gradle-version: 7.6.1
     - name: Run tests
       run: |
         npm install
@@ -71,12 +71,12 @@ jobs:
       runner-os: '["ubuntu-latest"]'
       download-dist: true
 
-  restore-configuration-cache:
-    needs: build-distribution
-    uses: ./.github/workflows/integ-test-restore-configuration-cache.yml
-    with:
-      runner-os: '["ubuntu-latest"]'
-      download-dist: true
+  # restore-configuration-cache:
+  #   needs: build-distribution
+  #   uses: ./.github/workflows/integ-test-restore-configuration-cache.yml
+  #   with:
+  #     runner-os: '["ubuntu-latest"]'
+  #     download-dist: true
 
   restore-containerized-gradle-home:
     needs: build-distribution

.tool-versions

@@ -1,2 +1,3 @@
 # Configuration file for asdf version manager
-nodejs 16.18.1
+nodejs 16.18.1
+gradle 7.6.1

README.md

@@ -197,7 +197,6 @@ By default, this action aims to cache any and all reusable state that may be spe
 The state that is cached includes:
 - Any distributions downloaded to satisfy a `gradle-version` parameter ;
 - A subset of the Gradle User Home directory, including downloaded dependencies, wrapper distributions, and the local build cache ;
-- Any [configuration-cache](https://docs.gradle.org/nightly/userguide/configuration_cache.html) data stored in the project `.gradle` directory. (Only supported for Gradle 7 or higher.)
 
 To reduce the space required for caching, this action makes a best effort to reduce duplication in cache entries.
 
@@ -209,7 +208,7 @@ cache-disabled: true
 
 Distributions downloaded to satisfy a `gradle-version` parameter are stored outside of Gradle User Home and cached separately. The cache key is unique to the downloaded distribution and will not change over time.
 
-The state of the Gradle User Home and configuration-cache are highly dependent on the Gradle execution, so the cache key is composed of the current commit hash and the GitHub actions job id.
+The state of the Gradle User Home is highly dependent on the Gradle execution, so the cache key is composed of the current commit hash and the GitHub actions job id.
 As such, the cache key is likely to change on each subsequent run of GitHub actions. 
 This allows the most recent state to always be available in the GitHub actions cache.
 
@@ -252,9 +251,10 @@ gradle-home-cache-includes: |
     caches
     notifications
     jdks
-# Exclude the local build-cache from the directories cached.
+# Exclude the local build-cache and keyrings from the directories cached.
 gradle-home-cache-excludes: |
     caches/build-cache-1
+    caches/keyrings
 ```
 
 You can specify any number of fixed paths or patterns to include or exclude. 

package.json

@@ -26,29 +26,29 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "3.1.3",
+    "@actions/cache": "3.2.1",
     "@actions/core": "1.10.0",
     "@actions/exec": "1.1.1",
     "@actions/github": "5.1.1",
     "@actions/glob": "0.4.0",
-    "@actions/http-client": "2.0.1",
+    "@actions/http-client": "2.1.0",
     "@actions/tool-cache": "2.0.1",
     "string-argv": "0.3.1"
   },
   "devDependencies": {
-    "@types/jest": "28.1.7",
     "@types/node": "16.11.21",
+    "@types/jest": "29.5.0",
     "@types/unzipper": "0.10.5",
-    "@typescript-eslint/parser": "5.52.0",
+    "@typescript-eslint/parser": "5.58.0",
     "@vercel/ncc": "0.36.1",
-    "eslint": "8.34.0",
-    "eslint-plugin-github": "4.6.0",
+    "eslint": "8.38.0",
+    "eslint-plugin-github": "4.7.0",
     "eslint-plugin-jest": "27.2.1",
-    "jest": "28.1.3",
+    "jest": "29.5.0",
     "js-yaml": "4.1.0", 
     "patch-package": "6.5.1",
-    "prettier": "2.8.4",
-    "ts-jest": "28.0.8",
-    "typescript": "4.9.5"
+    "prettier": "2.8.7",
+    "ts-jest": "29.1.0",
+    "typescript": "5.0.4"
   }
 }

patches/@actions+cache+3.2.1.patch

@@ -26,23 +26,12 @@ index 4658366..b796e58 100644
 +    constructor(key: string, size?: number);
 +}
 diff --git a/node_modules/@actions/cache/lib/cache.js b/node_modules/@actions/cache/lib/cache.js
-index 0fa9df3..5f0b173 100644
+index 9d636aa..a176bd7 100644
 --- a/node_modules/@actions/cache/lib/cache.js
 +++ b/node_modules/@actions/cache/lib/cache.js
-@@ -97,26 +97,18 @@ function restoreCache(paths, primaryKey, restoreKeys, options, enableCrossOsArch
-             }
-             archivePath = path.join(yield utils.createTempDirectory(), utils.getCacheFileName(compressionMethod));
-             core.debug(`Archive Path: ${archivePath}`);
-+            const restoredEntry = new CacheEntry(cacheEntry.cacheKey);
-             // Download the cache from the cache entry
-             yield cacheHttpClient.downloadCache(cacheEntry.archiveLocation, archivePath, options);
-             if (core.isDebug()) {
-                 yield tar_1.listTar(archivePath, compressionMethod);
-             }
-             const archiveFileSize = utils.getArchiveFileSizeInBytes(archivePath);
-+            restoredEntry.size = archiveFileSize;
+@@ -127,18 +127,21 @@ function restoreCache(paths, primaryKey, restoreKeys, options, enableCrossOsArch
              core.info(`Cache Size: ~${Math.round(archiveFileSize / (1024 * 1024))} MB (${archiveFileSize} B)`);
-             yield tar_1.extractTar(archivePath, compressionMethod);
+             yield (0, tar_1.extractTar)(archivePath, compressionMethod);
              core.info('Cache restored successfully');
 -            return cacheEntry.cacheKey;
 -        }
@@ -55,29 +44,31 @@ index 0fa9df3..5f0b173 100644
 -                // Supress all non-validation cache related errors because caching should be optional
 -                core.warning(`Failed to restore: ${error.message}`);
 -            }
-+            return restoredEntry;
++
++            // PATCHED - Return more inforamtion about restored entry
++            return new CacheEntry(cacheEntry.cacheKey, archiveFileSize);;
          }
++        // PATCHED - propagate errors
++        // catch (error) {
++        //     const typedError = error;
++        //     if (typedError.name === ValidationError.name) {
++        //         throw error;
++        //     }
++        //     else {
++        //         // Supress all non-validation cache related errors because caching should be optional
++        //         core.warning(`Failed to restore: ${error.message}`);
++        //     }
++        // }
          finally {
              // Try to delete the archive to save space
-@@ -156,6 +148,7 @@ function saveCache(paths, key, options, enableCrossOsArchive = false) {
-         const archiveFolder = yield utils.createTempDirectory();
-         const archivePath = path.join(archiveFolder, utils.getCacheFileName(compressionMethod));
-         core.debug(`Archive Path: ${archivePath}`);
-+        const savedEntry = new CacheEntry(key);
-         try {
-             yield tar_1.createTar(archiveFolder, cachePaths, compressionMethod);
-             if (core.isDebug()) {
-@@ -163,6 +156,7 @@ function saveCache(paths, key, options, enableCrossOsArchive = false) {
+             try {
+@@ -206,19 +209,23 @@ function saveCache(paths, key, options, enableCrossOsArchive = false) {
              }
-             const fileSizeLimit = 10 * 1024 * 1024 * 1024; // 10GB per repo limit
-             const archiveFileSize = utils.getArchiveFileSizeInBytes(archivePath);
-+            savedEntry.size = archiveFileSize;
-             core.debug(`File Size: ${archiveFileSize}`);
-             // For GHES, this check will take place in ReserveCache API with enterprise file size limit
-             if (archiveFileSize > fileSizeLimit && !utils.isGhes()) {
-@@ -186,18 +180,6 @@ function saveCache(paths, key, options, enableCrossOsArchive = false) {
              core.debug(`Saving Cache (ID: ${cacheId})`);
              yield cacheHttpClient.saveCache(cacheId, archivePath, options);
++
++            // PATCHED - Return more inforamtion about saved entry
++            return new CacheEntry(key, archiveFileSize);
          }
 -        catch (error) {
 -            const typedError = error;
@@ -91,15 +82,23 @@ index 0fa9df3..5f0b173 100644
 -                core.warning(`Failed to save: ${typedError.message}`);
 -            }
 -        }
++        // PATCHED - propagate errors
++        // catch (error) {
++        //     const typedError = error;
++        //     if (typedError.name === ValidationError.name) {
++        //         throw error;
++        //     }
++        //     else if (typedError.name === ReserveCacheError.name) {
++        //         core.info(`Failed to save: ${typedError.message}`);
++        //     }
++        //     else {
++        //         core.warning(`Failed to save: ${typedError.message}`);
++        //     }
++        // }
          finally {
              // Try to delete the archive to save space
              try {
-@@ -207,8 +189,15 @@ function saveCache(paths, key, options, enableCrossOsArchive = false) {
-                 core.debug(`Failed to delete archive: ${error}`);
-             }
-         }
--        return cacheId;
-+        return savedEntry;
+@@ -232,4 +239,11 @@ function saveCache(paths, key, options, enableCrossOsArchive = false) {
      });
  }
  exports.saveCache = saveCache;

patches/@azure+logger+1.0.4.patch

@@ -1,8 +1,18 @@
-# Patch removes logging of the AZURE_LOG_LEVEL env var value
-# This logging triggers a high severity Warning from CodeQL, which can prevent organizational users from adopting the action.
-
+diff --git a/node_modules/@azure/logger/dist-esm/src/debug.js b/node_modules/@azure/logger/dist-esm/src/debug.js
+index d202779..30e8313 100644
+--- a/node_modules/@azure/logger/dist-esm/src/debug.js
++++ b/node_modules/@azure/logger/dist-esm/src/debug.js
+@@ -7,7 +7,7 @@ let enabledNamespaces = [];
+ let skippedNamespaces = [];
+ const debuggers = [];
+ if (debugEnvVariable) {
+-    enable(debugEnvVariable);
++    // enable(debugEnvVariable);
+ }
+ const debugObj = Object.assign((namespace) => {
+     return createDebugger(namespace);
 diff --git a/node_modules/@azure/logger/dist-esm/src/index.js b/node_modules/@azure/logger/dist-esm/src/index.js
-index 116b59e..cf87f3c 100644
+index cc25720..2925db5 100644
 --- a/node_modules/@azure/logger/dist-esm/src/index.js
 +++ b/node_modules/@azure/logger/dist-esm/src/index.js
 @@ -20,7 +20,7 @@ if (logLevelFromEnv) {
@@ -15,10 +25,19 @@ index 116b59e..cf87f3c 100644
  }
  /**
 diff --git a/node_modules/@azure/logger/dist/index.js b/node_modules/@azure/logger/dist/index.js
-index 327fbdb..4432d73 100644
+index 81e97c3..a415e2f 100644
 --- a/node_modules/@azure/logger/dist/index.js
 +++ b/node_modules/@azure/logger/dist/index.js
-@@ -122,7 +122,7 @@ if (logLevelFromEnv) {
+@@ -21,7 +21,7 @@ let enabledNamespaces = [];
+ let skippedNamespaces = [];
+ const debuggers = [];
+ if (debugEnvVariable) {
+-    enable(debugEnvVariable);
++    // enable(debugEnvVariable);
+ }
+ const debugObj = Object.assign((namespace) => {
+     return createDebugger(namespace);
+@@ -125,7 +125,7 @@ if (logLevelFromEnv) {
          setLogLevel(logLevelFromEnv);
      }
      else {

src/cache-base.ts

@@ -4,7 +4,7 @@ import path from 'path'
 import fs from 'fs'
 import {CacheListener} from './cache-reporting'
 import {saveCache, restoreCache, cacheDebug, isCacheDebuggingEnabled, tryDelete, generateCacheKey} from './cache-utils'
-import {ConfigurationCacheEntryExtractor, GradleHomeEntryExtractor} from './cache-extract-entries'
+import {GradleHomeEntryExtractor} from './cache-extract-entries'
 
 const RESTORED_CACHE_KEY_KEY = 'restored-cache-key'
 
@@ -80,7 +80,7 @@ export class GradleStateCache {
     async afterRestore(listener: CacheListener): Promise<void> {
         await this.debugReportGradleUserHomeSize('as restored from cache')
         await new GradleHomeEntryExtractor(this.gradleUserHome).restore(listener)
-        await new ConfigurationCacheEntryExtractor(this.gradleUserHome).restore(listener)
+        // await new ConfigurationCacheEntryExtractor(this.gradleUserHome).restore(listener)
         await this.debugReportGradleUserHomeSize('after restoring common artifacts')
     }
 
@@ -130,8 +130,8 @@ export class GradleStateCache {
         await this.debugReportGradleUserHomeSize('before saving common artifacts')
         this.deleteExcludedPaths()
         await Promise.all([
-            new GradleHomeEntryExtractor(this.gradleUserHome).extract(listener),
-            new ConfigurationCacheEntryExtractor(this.gradleUserHome).extract(listener)
+            new GradleHomeEntryExtractor(this.gradleUserHome).extract(listener)
+            // new ConfigurationCacheEntryExtractor(this.gradleUserHome).extract(listener)
         ])
         await this.debugReportGradleUserHomeSize(
             "after extracting common artifacts (only 'caches' and 'notifications' will be stored)"

src/cache-cleaner.ts

@@ -48,7 +48,7 @@ export class CacheCleaner {
     }
 
     private async ageAllFiles(fileName = '*'): Promise<void> {
-        core.debug(`Aging all files in Gradle User Homee with name ${fileName}`)
+        core.debug(`Aging all files in Gradle User Home with name ${fileName}`)
         await this.setUtimes(`${this.gradleUserHome}/**/${fileName}`, new Date(0))
     }
 

src/cache-utils.ts

@@ -9,7 +9,7 @@ import * as fs from 'fs'
 
 import {CacheEntryListener} from './cache-reporting'
 
-const CACHE_PROTOCOL_VERSION = 'v6-'
+const CACHE_PROTOCOL_VERSION = 'v7-'
 
 const JOB_CONTEXT_PARAMETER = 'workflow-job-context'
 const CACHE_DISABLED_PARAMETER = 'cache-disabled'

test/init-scripts/settings.gradle

@@ -1,6 +1,6 @@
 plugins {
-    id "com.gradle.enterprise" version "3.12.3"
-    id "com.gradle.common-custom-user-data-gradle-plugin" version "1.8.2"
+    id "com.gradle.enterprise" version "3.12.6"
+    id "com.gradle.common-custom-user-data-gradle-plugin" version "1.10"
 }
 
 gradleEnterprise {

test/init-scripts/src/test/groovy/com/gradle/gradlebuildaction/BaseInitScriptTest.groovy

@@ -21,9 +21,9 @@ class BaseInitScriptTest extends Specification {
     static final TestGradleVersion GRADLE_4_X = new TestGradleVersion(GradleVersion.version('4.10.3'), 7, 10)
     static final TestGradleVersion GRADLE_5_X = new TestGradleVersion(GradleVersion.version('5.6.4'), 8, 12)
     static final TestGradleVersion GRADLE_6_NO_BUILD_SERVICE = new TestGradleVersion(GradleVersion.version('6.5.1'), 8, 14)
-    static final TestGradleVersion GRADLE_6_X = new TestGradleVersion(GradleVersion.version('6.9.3'), 8, 15)
-    static final TestGradleVersion GRADLE_7_X = new TestGradleVersion(GradleVersion.version('7.6'), 8, 19)
-    static final TestGradleVersion GRADLE_8_X = new TestGradleVersion(GradleVersion.version('8.0.1'), 8, 19)
+    static final TestGradleVersion GRADLE_6_X = new TestGradleVersion(GradleVersion.version('6.9.4'), 8, 15)
+    static final TestGradleVersion GRADLE_7_X = new TestGradleVersion(GradleVersion.version('7.6.1'), 8, 19)
+    static final TestGradleVersion GRADLE_8_X = new TestGradleVersion(GradleVersion.version('8.0.2'), 8, 19)
 
     static final List<TestGradleVersion> ALL_VERSIONS = [
         GRADLE_3_X, // First version where TestKit supports environment variables
@@ -134,7 +134,7 @@ class BaseInitScriptTest extends Specification {
         } else {
             """
               plugins {
-                id 'com.gradle.enterprise' version '3.12.3'
+                id 'com.gradle.enterprise' version '3.12.6'
               }
               gradleEnterprise {
                 server = '$mockScansServer.address'
@@ -160,7 +160,7 @@ class BaseInitScriptTest extends Specification {
         } else if (gradleVersion < GradleVersion.version('6.0')) {
             """
               plugins {
-                id 'com.gradle.build-scan' version '3.12.3'
+                id 'com.gradle.build-scan' version '3.12.6'
               }
               gradleEnterprise {
                 server = '$mockScansServer.address'

test/jest/cache-cleanup.test.ts

@@ -49,7 +49,7 @@ test('will cleanup unused gradle versions', async () => {
 
     const gradle733 = path.resolve(gradleUserHome, "caches/7.3.3")
     const wrapper733 = path.resolve(gradleUserHome, "wrapper/dists/gradle-7.3.3-bin")
-    const gradleCurrent = path.resolve(gradleUserHome, "caches/7.6")
+    const gradleCurrent = path.resolve(gradleUserHome, "caches/7.6.1")
 
     expect(fs.existsSync(gradle733)).toBe(true)
     expect(fs.existsSync(wrapper733)).toBe(true)