Update action.yml for [email protected]

Author: bigdaz

action.yml

@@ -1,13 +1,14 @@
 name: "Gradle Build Action"
 description: 'Configures Gradle for GitHub actions, caching state and generating a dependency graph via Dependency Submission.'
 
-# https://help.github.com/en/articles/metadata-syntax-for-github-actions
-
 inputs:
   gradle-version:
-    description: Gradle version to use. If specified, this Gradle version will be downloaded, added to the PATH and used for invoking Gradle.
+    description: |
+      Gradle version to use. If specified, this Gradle version will be downloaded, added to the PATH and used for invoking Gradle.
+      If not provided, it is assumed that the project uses the Gradle Wrapper.
     required: false
 
+  # Cache configuration
   cache-disabled:
     description: When 'true', all caching is disabled. No entries will be written to or read from the cache.
     required: false
@@ -49,15 +50,13 @@ inputs:
   gradle-home-cache-excludes:
     description: Paths within Gradle User Home to exclude from cache.
     required: false
-  # e.g. Use the following setting to prevent the local build cache from being saved/restored
-  #      gradle-home-cache-excludes: |
-  #           caches/build-cache-1
 
   gradle-home-cache-cleanup:
     description: When 'true', the action will attempt to remove any stale/unused entries from the Gradle User Home prior to saving to the GitHub Actions cache.
     required: false
     default: false
 
+  # Job summary configuration
   add-job-summary:
     description: Specifies when a Job Summary should be inluded in the action results. Valid values are 'never', 'always' (default), and 'on-failure'.
     required: false
@@ -68,8 +67,11 @@ inputs:
     required: false
     default: 'never'
 
+  # Dependency Graph configuration
   dependency-graph:
-    description: Specifies if a GitHub dependency snapshot should be generated for each Gradle build, and if so, how. Valid values are 'disabled' (default), 'generate', 'generate-and-submit', 'generate-and-upload', 'download-and-submit' and 'clear'.
+    description: |
+      Specifies if a GitHub dependency snapshot should be generated for each Gradle build, and if so, how. 
+      Valid values are 'disabled' (default), 'generate', 'generate-and-submit', 'generate-and-upload', 'download-and-submit' and 'clear'.
     required: false
     default: 'disabled'
 
@@ -82,6 +84,7 @@ inputs:
     description: Specifies the number of days to retain any artifacts generated by the action. If not set, the default retention settings for the repository will apply.
     required: false
 
+  # Build Scan configuration
   build-scan-publish:
     description: |
       Set to 'true' to automatically publish build results as a Build Scan on scans.gradle.com.
@@ -97,6 +100,14 @@ inputs:
     description: Indicate that you agree to the Build Scan® terms of use. This input value must be "yes".
     required: false
 
+  # Wrapper validation configuration
+  validate-wrappers:
+    description: |
+      When 'true', the action will perform the 'wrapper-validation' action automatically.
+      If the wrapper checksums are not valid, the action will fail.
+    required: false
+    default: false
+
   # DEPRECATED ACTION INPUTS
   build-scan-terms-of-service-url:
     description: The URL to the Build Scan® terms of use. This input must be set to 'https://gradle.com/terms-of-service'.
@@ -108,31 +119,33 @@ inputs:
     required: false
     deprecation-message: The input has been renamed to align with the Develocity API. Use 'build-scan-terms-of-use-agree' instead.
 
+  generate-job-summary:
+    description: When 'false', no Job Summary will be generated for the Job.
+    required: false
+    default: true
+    deprecation-message: Superceded by the new 'add-job-summary' and 'add-job-summary-as-pr-comment' parameters.
+
   arguments:
     description: Gradle command line arguments (supports multi-line input)
     required: false
-    deprecation-message: Using the action to execute Gradle directly is deprecated in favor of using the action to setup Gradle, and executing Gradle in a subsequent Step. See https://github.com/gradle/gradle-build-action?tab=readme-ov-file#use-the-action-to-setup-gradle. 
+    deprecation-message: Using the action to execute Gradle directly is deprecated in favor of using the action to setup Gradle, and executing Gradle in a subsequent Step.
 
   build-root-directory:
     description: Path to the root directory of the build. Default is the root of the GitHub workspace.
     required: false
-    deprecation-message: Using the action to execute Gradle directly is deprecated in favor of using the action to setup Gradle, and executing Gradle in a subsequent Step. See https://github.com/gradle/gradle-build-action?tab=readme-ov-file#use-the-action-to-setup-gradle. 
-
-  generate-job-summary:
-    description: When 'false', no Job Summary will be generated for the Job.
-    required: false
-    default: true
-    deprecation-message: Superceded by the new 'add-job-summary' and 'add-job-summary-as-pr-comment' parameters.
+    deprecation-message: Using the action to execute Gradle directly is deprecated in favor of using the action to setup Gradle, and executing Gradle in a subsequent Step.
 
-  # EXPERIMENTAL & INTERNAL ACTION INPUTS
+  # EXPERIMENTAL ACTION INPUTS
   # The following action properties allow fine-grained tweaking of the action caching behaviour.
-  # These properties are experimental and not (yet) designed for production use, and may change without notice in a subsequent release of `gradle-build-action`.
+  # These properties are experimental and not (yet) designed for production use, and may change without notice in a subsequent release of `setup-gradle`.
   # Use at your own risk!
   gradle-home-cache-strict-match:
     description: When 'true', the action will not attempt to restore the Gradle User Home entries from other Jobs.
     required: false
     default: false
 
+  # INTERNAL ACTION INPUTS
+  # These inputs should not be configured directly, and are only used to pass environmental information to the action
   workflow-job-context:
     description: Used to uniquely identify the current job invocation. Defaults to the matrix values for this job; this should not be overridden by users (INTERNAL).
     required: false
@@ -145,21 +158,18 @@ inputs:
 
 outputs:
   build-scan-url:
-    description: Link to the Build Scan® generated by a Gradle build. Note that this output applies to a Step executing Gradle, not to the `gradle-build-action` Step itself.
-    value: ${{ steps.setup-gradle.outputs.build-scan-url }}
+    description: Link to the Build Scan® generated by a Gradle build. Note that this output applies to a Step executing Gradle, not to the `setup-gradle` Step itself.
   dependency-graph-file:
-    description: Path to the GitHub Dependency Graph snapshot file generated by a Gradle build. Note that this output applies to a Step executing Gradle, not to the `gradle-build-action` Step itself.
-    value: ${{ steps.setup-gradle.outputs.dependency-graph-file }}
+    description: Path to the GitHub Dependency Graph snapshot file generated by a Gradle build. Note that this output applies to a Step executing Gradle, not to the `setup-gradle` Step itself.
   gradle-version:
     description: Version of Gradle that was setup by the action
-    value: ${{ steps.setup-gradle.outputs.gradle-version }}
 
 runs:
   using: "composite"
   steps:
     - name: Setup Gradle
       id: setup-gradle
-      uses: gradle/actions/setup-gradle@v3.2.1
+      uses: gradle/actions/setup-gradle@v3.3.0
       with:
         gradle-version: ${{ inputs.gradle-version }}
         cache-disabled: ${{ inputs.cache-disabled }}
@@ -178,11 +188,12 @@ runs:
         build-scan-publish: ${{ inputs.build-scan-publish }}
         build-scan-terms-of-use-url: ${{ inputs.build-scan-terms-of-use-url }}
         build-scan-terms-of-use-agree: ${{ inputs.build-scan-terms-of-use-agree }}
+        validate-wrappers: ${{ inputs.validate-wrappers }}
         build-scan-terms-of-service-url: ${{ inputs.build-scan-terms-of-service-url }}
         build-scan-terms-of-service-agree: ${{ inputs.build-scan-terms-of-service-agree }}
+        generate-job-summary: ${{ inputs.generate-job-summary }}
         arguments: ${{ inputs.arguments }}
         build-root-directory: ${{ inputs.build-root-directory }}
-        generate-job-summary: ${{ inputs.generate-job-summary }}
         gradle-home-cache-strict-match: ${{ inputs.gradle-home-cache-strict-match }}
         workflow-job-context: ${{ inputs.workflow-job-context }}
         github-token: ${{ inputs.github-token }}