rezajax/Gradle NG

Configures Gradle for GitHub actions, caching state and generating a dependency graph via Dependency Submission.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
gradle-versionGradle 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. no
cache-disabledWhen 'true', all caching is disabled. No entries will be written to or read from the cache.nofalse
cache-read-onlyWhen 'true', existing entries will be read from the cache but no entries will be written. By default this value is 'false' for workflows on the GitHub default branch and 'true' for workflows on other branches. no${{ github.event.repository != null && github.ref_name != github.event.repository.default_branch }}
cache-write-onlyWhen 'true', entries will not be restored from the cache but will be saved at the end of the Job. Setting this to 'true' implies cache-read-only will be 'false'. nofalse
cache-overwrite-existingWhen 'true', a pre-existing Gradle User Home will not prevent the cache from being restored.nofalse
cache-encryption-keyA base64 encoded AES key used to encrypt the configuration-cache data. The key is exported as 'GRADLE_ENCRYPTION_KEY' for later steps. A suitable key can be generated with `openssl rand -base64 16`. Configuration-cache data will not be saved/restored without an encryption key being provided. no
gradle-home-cache-includesPaths within Gradle User Home to cache.nocaches notifications
gradle-home-cache-excludesPaths within Gradle User Home to exclude from cache.no
gradle-home-cache-cleanupWhen 'true', the action will attempt to remove any stale/unused entries from the Gradle User Home prior to saving to the GitHub Actions cache.nofalse
add-job-summarySpecifies when a Job Summary should be inluded in the action results. Valid values are 'never', 'always' (default), and 'on-failure'.noalways
add-job-summary-as-pr-commentSpecifies when each Job Summary should be added as a PR comment. Valid values are 'never' (default), 'always', and 'on-failure'. No action will be taken if the workflow was not triggered from a pull request.nonever
dependency-graphSpecifies 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'. nodisabled
dependency-graph-continue-on-failureWhen 'false' a failure to generate or submit a dependency graph will fail the Step or Job. When 'true' a warning will be emitted but no failure will result.notrue
artifact-retention-daysSpecifies the number of days to retain any artifacts generated by the action. If not set, the default retention settings for the repository will apply.no
build-scan-publishSet to 'true' to automatically publish build results as a Build Scan on scans.gradle.com. For publication to succeed without user input, you must also provide values for `build-scan-terms-of-use-url` and 'build-scan-terms-of-use-agree'. nofalse
build-scan-terms-of-use-urlThe URL to the Build Scan® terms of use. This input must be set to 'https://gradle.com/terms-of-service' or 'https://gradle.com/help/legal-terms-of-use'.no
build-scan-terms-of-use-agreeIndicate that you agree to the Build Scan® terms of use. This input value must be "yes".no
validate-wrappersWhen 'true', the action will perform the 'wrapper-validation' action automatically. If the wrapper checksums are not valid, the action will fail. nofalse
build-scan-terms-of-service-urlThe URL to the Build Scan® terms of use. This input must be set to 'https://gradle.com/terms-of-service'.no
build-scan-terms-of-service-agreeIndicate that you agree to the Build Scan® terms of use. This input value must be "yes".no
generate-job-summaryWhen 'false', no Job Summary will be generated for the Job.notrue
argumentsGradle command line arguments (supports multi-line input)no
build-root-directoryPath to the root directory of the build. Default is the root of the GitHub workspace.no
gradle-home-cache-strict-matchWhen 'true', the action will not attempt to restore the Gradle User Home entries from other Jobs.nofalse
workflow-job-contextUsed to uniquely identify the current job invocation. Defaults to the matrix values for this job; this should not be overridden by users (INTERNAL).no${{ toJSON(matrix) }}
github-tokenThe GitHub token used to authenticate when submitting via the Dependency Submission API.no${{ github.token }}
namedescription
build-scan-urlLink 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-filePath 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-versionVersion of Gradle that was setup by the action