actions-marketplace-validations/setup-gradle

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

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stalelast commit Aug 7, 2024
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: actions-marketplace-validations/gradle_gradle-build-action@093dfe9d598ec5a42246855d09b49dc76803c005 # no releases — HEAD as of 2026-07-10

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
gradle-version	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.	no	—
cache-disabled	When 'true', all caching is disabled. No entries will be written to or read from the cache.	no	false
cache-read-only	When '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-only	When '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'.	no	false
cache-overwrite-existing	When 'true', a pre-existing Gradle User Home will not prevent the cache from being restored.	no	false
cache-encryption-key	A 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-includes	Paths within Gradle User Home to cache.	no	caches notifications
gradle-home-cache-excludes	Paths within Gradle User Home to exclude from cache.	no	—
gradle-home-cache-cleanup	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.	no	false
add-job-summary	Specifies when a Job Summary should be inluded in the action results. Valid values are 'never', 'always' (default), and 'on-failure'.	no	always
add-job-summary-as-pr-comment	Specifies 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.	no	never
dependency-graph	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'.	no	disabled
dependency-graph-continue-on-failure	When '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.	no	true
artifact-retention-days	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.	no	—
build-scan-publish	Set 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'.	no	false
build-scan-terms-of-use-url	The 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-agree	Indicate that you agree to the Build Scan® terms of use. This input value must be "yes".	no	—
develocity-access-key	Develocity access key. Should be set to a secret containing the Develocity Access key.	no	—
develocity-token-expiry	The Develocity short-lived access tokens expiry in hours. Default is 2 hours.	no	—
develocity-injection-enabled	Enables Develocity injection.	no	—
develocity-url	The URL for the Develocity server.	no	—
develocity-allow-untrusted-server	Allow communication with an untrusted server; set to _true_ if your Develocity instance is using a self-signed.	no	—
develocity-capture-file-fingerprints	Enables capturing the paths and content hashes of each individual input file.	no	—
develocity-enforce-url	Enforce the configured Develocity URL over a URL configured in the project's build; set to _true_ to enforce publication of build scans to the configured Develocity URL.	no	—
develocity-plugin-version	The version of the Develocity Gradle plugin to apply.	no	—
develocity-ccud-plugin-version	The version of the Common Custom User Data Gradle plugin to apply, if any.	no	—
gradle-plugin-repository-url	The URL of the repository to use when resolving the Develocity and CCUD plugins; the Gradle Plugin Portal is used by default.	no	—
gradle-plugin-repository-username	The username for the repository URL to use when resolving the Develocity and CCUD.	no	—
gradle-plugin-repository-password	The password for the repository URL to use when resolving the Develocity and CCUD plugins; Consider using secrets to pass the value to this variable.	no	—
validate-wrappers	When 'true', the action will perform the 'wrapper-validation' action automatically. If the wrapper checksums are not valid, the action will fail.	no	false
build-scan-terms-of-service-url	The 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-agree	Indicate that you agree to the Build Scan® terms of use. This input value must be "yes".	no	—
generate-job-summary	When 'false', no Job Summary will be generated for the Job.	no	true
arguments	Gradle command line arguments (supports multi-line input)	no	—
build-root-directory	Path to the root directory of the build. Default is the root of the GitHub workspace.	no	—
gradle-home-cache-strict-match	When 'true', the action will not attempt to restore the Gradle User Home entries from other Jobs.	no	false
workflow-job-context	Used 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-token	The GitHub token used to authenticate when submitting via the Dependency Submission API.	no	${{ github.token }}

Outputs

name	description
build-scan-url	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	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	Version of Gradle that was setup by the action