Use kotlin-dsl sample to demo failure

Use GHA Job Summary to summarize Gradle build results

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

@@ -1,5 +1,5 @@
 plugins {
-    id("com.gradle.enterprise") version "3.10"
+    id("com.gradle.enterprise") version "3.10.1"
 }
 
 gradleEnterprise {

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

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

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

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

.github/workflows/failure-cases.yml

@@ -8,6 +8,18 @@ env:
 
 jobs:
 
+  failing-build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v2
+    - name: Test build failure
+      uses: ./
+      continue-on-error: true
+      with:
+        build-root-directory: .github/workflow-samples/kotlin-dsl
+        arguments: not-a-valid-task
+
   wrapper-missing:
     runs-on: ubuntu-latest
     steps:

README.md

@@ -135,7 +135,7 @@ The initial Action step will perform the Gradle setup.
 
 ### Gradle command-line arguments
 
-The `arguments` input can used to pass arbitrary arguments to the `gradle` command line.
+The `arguments` input can be used to pass arbitrary arguments to the `gradle` command line.
 Arguments can be supplied in a single line, or as a multi-line input.
 
 Here are some valid examples:

package-lock.json

@@ -22,9 +22,9 @@
       "devDependencies": {
         "@types/node": "16.11.21",
         "@types/unzipper": "0.10.5",
-        "@typescript-eslint/parser": "5.23.0",
+        "@typescript-eslint/parser": "5.26.0",
         "@vercel/ncc": "0.33.4",
-        "eslint": "8.15.0",
+        "eslint": "8.16.0",
         "eslint-plugin-github": "4.3.6",
         "eslint-plugin-jest": "26.2.2",
         "jest": "28.1.0",
@@ -895,15 +895,15 @@
       "dev": true
     },
     "node_modules/@eslint/eslintrc": {
-      "version": "1.2.3",
+      "version": "1.3.0",
-      "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.2.3.tgz",
+      "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.3.0.tgz",
-      "integrity": "sha512-uGo44hIwoLGNyduRpjdEpovcbMdd+Nv7amtmJxnKmI8xj6yd5LncmSwDa5NgX/41lIFJtkjD6YdVfgEzPfJ5UA==",
+      "integrity": "sha512-UWW0TMTmk2d7hLcWD1/e2g5HDM/HQ3csaLSqXCfqwh4uNDuNqlaKWXmEsL4Cs41Z0KnILNvwbHAah3C2yt06kw==",
       "dev": true,
       "dependencies": {
         "ajv": "^6.12.4",
         "debug": "^4.3.2",
         "espree": "^9.3.2",
-        "globals": "^13.9.0",
+        "globals": "^13.15.0",
         "ignore": "^5.2.0",
         "import-fresh": "^3.2.1",
         "js-yaml": "^4.1.0",
@@ -1813,15 +1813,15 @@
       }
     },
     "node_modules/@typescript-eslint/parser": {
-      "version": "5.23.0",
+      "version": "5.26.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.23.0.tgz",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.26.0.tgz",
-      "integrity": "sha512-V06cYUkqcGqpFjb8ttVgzNF53tgbB/KoQT/iB++DOIExKmzI9vBJKjZKt/6FuV9c+zrDsvJKbJ2DOCYwX91cbw==",
+      "integrity": "sha512-n/IzU87ttzIdnAH5vQ4BBDnLPly7rC5VnjN3m0xBG82HK6rhRxnCb3w/GyWbNDghPd+NktJqB/wl6+YkzZ5T5Q==",
       "dev": true,
       "dependencies": {
-        "@typescript-eslint/scope-manager": "5.23.0",
+        "@typescript-eslint/scope-manager": "5.26.0",
-        "@typescript-eslint/types": "5.23.0",
+        "@typescript-eslint/types": "5.26.0",
-        "@typescript-eslint/typescript-estree": "5.23.0",
+        "@typescript-eslint/typescript-estree": "5.26.0",
-        "debug": "^4.3.2"
+        "debug": "^4.3.4"
       },
       "engines": {
         "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -1840,13 +1840,13 @@
       }
     },
     "node_modules/@typescript-eslint/parser/node_modules/@typescript-eslint/scope-manager": {
-      "version": "5.23.0",
+      "version": "5.26.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.23.0.tgz",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.26.0.tgz",
-      "integrity": "sha512-EhjaFELQHCRb5wTwlGsNMvzK9b8Oco4aYNleeDlNuL6qXWDF47ch4EhVNPh8Rdhf9tmqbN4sWDk/8g+Z/J8JVw==",
+      "integrity": "sha512-gVzTJUESuTwiju/7NiTb4c5oqod8xt5GhMbExKsCTp6adU3mya6AGJ4Pl9xC7x2DX9UYFsjImC0mA62BCY22Iw==",
       "dev": true,
       "dependencies": {
-        "@typescript-eslint/types": "5.23.0",
+        "@typescript-eslint/types": "5.26.0",
-        "@typescript-eslint/visitor-keys": "5.23.0"
+        "@typescript-eslint/visitor-keys": "5.26.0"
       },
       "engines": {
         "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -1857,9 +1857,9 @@
       }
     },
     "node_modules/@typescript-eslint/parser/node_modules/@typescript-eslint/types": {
-      "version": "5.23.0",
+      "version": "5.26.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.23.0.tgz",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.26.0.tgz",
-      "integrity": "sha512-NfBsV/h4dir/8mJwdZz7JFibaKC3E/QdeMEDJhiAE3/eMkoniZ7MjbEMCGXw6MZnZDMN3G9S0mH/6WUIj91dmw==",
+      "integrity": "sha512-8794JZFE1RN4XaExLWLI2oSXsVImNkl79PzTOOWt9h0UHROwJedNOD2IJyfL0NbddFllcktGIO2aOu10avQQyA==",
       "dev": true,
       "engines": {
         "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -1870,17 +1870,17 @@
       }
     },
     "node_modules/@typescript-eslint/parser/node_modules/@typescript-eslint/typescript-estree": {
-      "version": "5.23.0",
+      "version": "5.26.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.23.0.tgz",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.26.0.tgz",
-      "integrity": "sha512-xE9e0lrHhI647SlGMl+m+3E3CKPF1wzvvOEWnuE3CCjjT7UiRnDGJxmAcVKJIlFgK6DY9RB98eLr1OPigPEOGg==",
+      "integrity": "sha512-EyGpw6eQDsfD6jIqmXP3rU5oHScZ51tL/cZgFbFBvWuCwrIptl+oueUZzSmLtxFuSOQ9vDcJIs+279gnJkfd1w==",
       "dev": true,
       "dependencies": {
-        "@typescript-eslint/types": "5.23.0",
+        "@typescript-eslint/types": "5.26.0",
-        "@typescript-eslint/visitor-keys": "5.23.0",
+        "@typescript-eslint/visitor-keys": "5.26.0",
-        "debug": "^4.3.2",
+        "debug": "^4.3.4",
-        "globby": "^11.0.4",
+        "globby": "^11.1.0",
         "is-glob": "^4.0.3",
-        "semver": "^7.3.5",
+        "semver": "^7.3.7",
         "tsutils": "^3.21.0"
       },
       "engines": {
@@ -1897,13 +1897,13 @@
       }
     },
     "node_modules/@typescript-eslint/parser/node_modules/@typescript-eslint/visitor-keys": {
-      "version": "5.23.0",
+      "version": "5.26.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.23.0.tgz",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.26.0.tgz",
-      "integrity": "sha512-Vd4mFNchU62sJB8pX19ZSPog05B0Y0CE2UxAZPT5k4iqhRYjPnqyY3woMxCd0++t9OTqkgjST+1ydLBi7e2Fvg==",
+      "integrity": "sha512-wei+ffqHanYDOQgg/fS6Hcar6wAWv0CUPQ3TZzOWd2BLfgP539rb49bwua8WRAs7R6kOSLn82rfEu2ro6Llt8Q==",
       "dev": true,
       "dependencies": {
-        "@typescript-eslint/types": "5.23.0",
+        "@typescript-eslint/types": "5.26.0",
-        "eslint-visitor-keys": "^3.0.0"
+        "eslint-visitor-keys": "^3.3.0"
       },
       "engines": {
         "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -2825,12 +2825,12 @@
       }
     },
     "node_modules/eslint": {
-      "version": "8.15.0",
+      "version": "8.16.0",
-      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.15.0.tgz",
+      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.16.0.tgz",
-      "integrity": "sha512-GG5USZ1jhCu8HJkzGgeK8/+RGnHaNYZGrGDzUtigK3BsGESW/rs2az23XqE0WVwDxy1VRvvjSSGu5nB0Bu+6SA==",
+      "integrity": "sha512-MBndsoXY/PeVTDJeWsYj7kLZ5hQpJOfMYLsF6LicLHQWbRDG19lK5jOix4DPl8yY4SUFcE3txy86OzFLWT+yoA==",
       "dev": true,
       "dependencies": {
-        "@eslint/eslintrc": "^1.2.3",
+        "@eslint/eslintrc": "^1.3.0",
         "@humanwhocodes/config-array": "^0.9.2",
         "ajv": "^6.10.0",
         "chalk": "^4.0.0",
@@ -2848,7 +2848,7 @@
         "file-entry-cache": "^6.0.1",
         "functional-red-black-tree": "^1.0.1",
         "glob-parent": "^6.0.1",
-        "globals": "^13.6.0",
+        "globals": "^13.15.0",
         "ignore": "^5.2.0",
         "import-fresh": "^3.0.0",
         "imurmurhash": "^0.1.4",
@@ -7786,15 +7786,15 @@
       "dev": true
     },
     "@eslint/eslintrc": {
-      "version": "1.2.3",
+      "version": "1.3.0",
-      "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.2.3.tgz",
+      "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.3.0.tgz",
-      "integrity": "sha512-uGo44hIwoLGNyduRpjdEpovcbMdd+Nv7amtmJxnKmI8xj6yd5LncmSwDa5NgX/41lIFJtkjD6YdVfgEzPfJ5UA==",
+      "integrity": "sha512-UWW0TMTmk2d7hLcWD1/e2g5HDM/HQ3csaLSqXCfqwh4uNDuNqlaKWXmEsL4Cs41Z0KnILNvwbHAah3C2yt06kw==",
       "dev": true,
       "requires": {
         "ajv": "^6.12.4",
         "debug": "^4.3.2",
         "espree": "^9.3.2",
-        "globals": "^13.9.0",
+        "globals": "^13.15.0",
         "ignore": "^5.2.0",
         "import-fresh": "^3.2.1",
         "js-yaml": "^4.1.0",
@@ -8553,56 +8553,56 @@
       }
     },
     "@typescript-eslint/parser": {
-      "version": "5.23.0",
+      "version": "5.26.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.23.0.tgz",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.26.0.tgz",
-      "integrity": "sha512-V06cYUkqcGqpFjb8ttVgzNF53tgbB/KoQT/iB++DOIExKmzI9vBJKjZKt/6FuV9c+zrDsvJKbJ2DOCYwX91cbw==",
+      "integrity": "sha512-n/IzU87ttzIdnAH5vQ4BBDnLPly7rC5VnjN3m0xBG82HK6rhRxnCb3w/GyWbNDghPd+NktJqB/wl6+YkzZ5T5Q==",
       "dev": true,
       "requires": {
-        "@typescript-eslint/scope-manager": "5.23.0",
+        "@typescript-eslint/scope-manager": "5.26.0",
-        "@typescript-eslint/types": "5.23.0",
+        "@typescript-eslint/types": "5.26.0",
-        "@typescript-eslint/typescript-estree": "5.23.0",
+        "@typescript-eslint/typescript-estree": "5.26.0",
-        "debug": "^4.3.2"
+        "debug": "^4.3.4"
       },
       "dependencies": {
         "@typescript-eslint/scope-manager": {
-          "version": "5.23.0",
+          "version": "5.26.0",
-          "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.23.0.tgz",
+          "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.26.0.tgz",
-          "integrity": "sha512-EhjaFELQHCRb5wTwlGsNMvzK9b8Oco4aYNleeDlNuL6qXWDF47ch4EhVNPh8Rdhf9tmqbN4sWDk/8g+Z/J8JVw==",
+          "integrity": "sha512-gVzTJUESuTwiju/7NiTb4c5oqod8xt5GhMbExKsCTp6adU3mya6AGJ4Pl9xC7x2DX9UYFsjImC0mA62BCY22Iw==",
           "dev": true,
           "requires": {
-            "@typescript-eslint/types": "5.23.0",
+            "@typescript-eslint/types": "5.26.0",
-            "@typescript-eslint/visitor-keys": "5.23.0"
+            "@typescript-eslint/visitor-keys": "5.26.0"
           }
         },
         "@typescript-eslint/types": {
-          "version": "5.23.0",
+          "version": "5.26.0",
-          "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.23.0.tgz",
+          "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.26.0.tgz",
-          "integrity": "sha512-NfBsV/h4dir/8mJwdZz7JFibaKC3E/QdeMEDJhiAE3/eMkoniZ7MjbEMCGXw6MZnZDMN3G9S0mH/6WUIj91dmw==",
+          "integrity": "sha512-8794JZFE1RN4XaExLWLI2oSXsVImNkl79PzTOOWt9h0UHROwJedNOD2IJyfL0NbddFllcktGIO2aOu10avQQyA==",
           "dev": true
         },
         "@typescript-eslint/typescript-estree": {
-          "version": "5.23.0",
+          "version": "5.26.0",
-          "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.23.0.tgz",
+          "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.26.0.tgz",
-          "integrity": "sha512-xE9e0lrHhI647SlGMl+m+3E3CKPF1wzvvOEWnuE3CCjjT7UiRnDGJxmAcVKJIlFgK6DY9RB98eLr1OPigPEOGg==",
+          "integrity": "sha512-EyGpw6eQDsfD6jIqmXP3rU5oHScZ51tL/cZgFbFBvWuCwrIptl+oueUZzSmLtxFuSOQ9vDcJIs+279gnJkfd1w==",
           "dev": true,
           "requires": {
-            "@typescript-eslint/types": "5.23.0",
+            "@typescript-eslint/types": "5.26.0",
-            "@typescript-eslint/visitor-keys": "5.23.0",
+            "@typescript-eslint/visitor-keys": "5.26.0",
-            "debug": "^4.3.2",
+            "debug": "^4.3.4",
-            "globby": "^11.0.4",
+            "globby": "^11.1.0",
             "is-glob": "^4.0.3",
-            "semver": "^7.3.5",
+            "semver": "^7.3.7",
             "tsutils": "^3.21.0"
           }
         },
         "@typescript-eslint/visitor-keys": {
-          "version": "5.23.0",
+          "version": "5.26.0",
-          "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.23.0.tgz",
+          "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.26.0.tgz",
-          "integrity": "sha512-Vd4mFNchU62sJB8pX19ZSPog05B0Y0CE2UxAZPT5k4iqhRYjPnqyY3woMxCd0++t9OTqkgjST+1ydLBi7e2Fvg==",
+          "integrity": "sha512-wei+ffqHanYDOQgg/fS6Hcar6wAWv0CUPQ3TZzOWd2BLfgP539rb49bwua8WRAs7R6kOSLn82rfEu2ro6Llt8Q==",
           "dev": true,
           "requires": {
-            "@typescript-eslint/types": "5.23.0",
+            "@typescript-eslint/types": "5.26.0",
-            "eslint-visitor-keys": "^3.0.0"
+            "eslint-visitor-keys": "^3.3.0"
           }
         },
         "semver": {
@@ -9258,12 +9258,12 @@
       "dev": true
     },
     "eslint": {
-      "version": "8.15.0",
+      "version": "8.16.0",
-      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.15.0.tgz",
+      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.16.0.tgz",
-      "integrity": "sha512-GG5USZ1jhCu8HJkzGgeK8/+RGnHaNYZGrGDzUtigK3BsGESW/rs2az23XqE0WVwDxy1VRvvjSSGu5nB0Bu+6SA==",
+      "integrity": "sha512-MBndsoXY/PeVTDJeWsYj7kLZ5hQpJOfMYLsF6LicLHQWbRDG19lK5jOix4DPl8yY4SUFcE3txy86OzFLWT+yoA==",
       "dev": true,
       "requires": {
-        "@eslint/eslintrc": "^1.2.3",
+        "@eslint/eslintrc": "^1.3.0",
         "@humanwhocodes/config-array": "^0.9.2",
         "ajv": "^6.10.0",
         "chalk": "^4.0.0",
@@ -9281,7 +9281,7 @@
         "file-entry-cache": "^6.0.1",
         "functional-red-black-tree": "^1.0.1",
         "glob-parent": "^6.0.1",
-        "globals": "^13.6.0",
+        "globals": "^13.15.0",
         "ignore": "^5.2.0",
         "import-fresh": "^3.0.0",
         "imurmurhash": "^0.1.4",

package.json

@@ -36,9 +36,9 @@
   "devDependencies": {
     "@types/node": "16.11.21",
     "@types/unzipper": "0.10.5",
-    "@typescript-eslint/parser": "5.23.0",
+    "@typescript-eslint/parser": "5.26.0",
     "@vercel/ncc": "0.33.4",
-    "eslint": "8.15.0",
+    "eslint": "8.16.0",
     "eslint-plugin-github": "4.3.6",
     "eslint-plugin-jest": "26.2.2",
     "jest": "28.1.0",

release/changes.md

@@ -1 +1 @@
-[FIX] Save/restore exploded Gradle dist rather than zip
+- [NEW] Use Job Summary to display build scan links, instead of GHA annotations

src/cache-base.ts

@@ -264,22 +264,20 @@ if (isTopLevelBuild) {
 
 def registerCallbacks(buildScanExtension, rootProjectName) {
     buildScanExtension.with {
-        def scanFile = new File("gradle-build-scan.txt")
         def buildFailed = false
-
         buildFinished { result ->
             buildFailed = (result.failure != null)
         }
 
         buildScanPublished { buildScan ->
-            scanFile.text = buildScan.buildScanUri
-
             // Send commands directly to GitHub Actions via STDOUT.
             def gradleCommand = rootProjectName + " " + gradle.startParameter.taskNames.join(" ")
+
+            def githubSummaryFile = new File(System.getenv("GITHUB_STEP_SUMMARY"))
             if (buildFailed) {
-                println("::warning ::Gradle build '\${gradleCommand}' FAILED - \${buildScan.buildScanUri}")
+                githubSummaryFile << ":x: Gradle Build \`\${gradleCommand}\` [![Gradle Enterprise Build Scan](https://img.shields.io/badge/Gradle%20Enterprise%20Build%20Scan%E2%84%A2-FAILED-red?logo=Gradle)](\${buildScan.buildScanUri})"
             } else {
-                println("::notice ::Gradle build '\${gradleCommand}' - \${buildScan.buildScanUri}")
+                githubSummaryFile << ":white_check_mark: Gradle Build \`\${gradleCommand}\` [![Gradle Enterprise Build Scan](https://img.shields.io/badge/Gradle%20Enterprise%20Build%20Scan%E2%84%A2-SUCCESS-brightgreen?logo=Gradle)](\${buildScan.buildScanUri})"
             }
             println("::set-output name=build-scan-url::\${buildScan.buildScanUri}")
         }

src/execution.ts

@@ -1,17 +1,9 @@
 import * as core from '@actions/core'
 import * as exec from '@actions/exec'
 import fs from 'fs'
-import path from 'path'
 import * as gradlew from './gradlew'
 
 export async function executeGradleBuild(executable: string | undefined, root: string, args: string[]): Promise<void> {
-    let buildScanUrl: string | undefined
-
-    const buildScanFile = path.resolve(root, 'gradle-build-scan.txt')
-    if (fs.existsSync(buildScanFile)) {
-        fs.unlinkSync(buildScanFile)
-    }
-
     // Use the provided executable, or look for a Gradle wrapper script to run
     const toExecute = executable ?? gradlew.locateGradleWrapperScript(root)
     verifyIsExecutableScript(toExecute)
@@ -20,16 +12,8 @@ export async function executeGradleBuild(executable: string | undefined, root: s
         ignoreReturnCode: true
     })
 
-    if (fs.existsSync(buildScanFile)) {
-        buildScanUrl = fs.readFileSync(buildScanFile, 'utf-8')
-    }
-
     if (status !== 0) {
-        if (buildScanUrl) {
+        core.setFailed(`Gradle build failed: see console output for details`)
-            core.setFailed(`Gradle build failed: ${buildScanUrl}`)
-        } else {
-            core.setFailed(`Gradle build failed: process exited with status ${status}`)
-        }
     }
 }