actions/README.md

Execute Gradle builds in GitHub Actions workflows

This GitHub Action can be used to configure Gradle and optionally execute a Gradle build on any platform supported by GitHub Actions.

Why use the gradle-build-action?

It is possible to directly invoke Gradle in your workflow, and the actions/setup-java@v4 action provides a simple way to cache Gradle dependencies.

However, the gradle-build-action offers a number of advantages over this approach:

• Easily configure your workflow to use a specific version of Gradle using the gradle-version parameter. Gradle distributions are automatically downloaded and cached.
• More sophisticated and more efficient caching of Gradle User Home between invocations, compared to setup-java and most custom configurations using actions/cache. More details below.
• Detailed reporting of cache usage and cache configuration options allow you to optimize the use of the GitHub actions cache.
• Generate and Submit a GitHub Dependency Graph for your project, enabling Dependabot security alerts.
• Automatic capture of Build Scan® links from the build, making these easier to locate for workflow run.

The gradle-build-action is designed to provide these benefits with minimal configuration. These features work both when Gradle is executed via the gradle-build-action and for any Gradle execution in subsequent steps.

Use the action to setup Gradle

The recommended way to use the gradle-build-action is in an initial "Setup Gradle" step, with subsequent steps invoking Gradle directly with a run step. This makes the action minimally invasive, and allows a workflow to configure and execute a Gradle execution in any way.

The gradle-build-action works by configuring environment variables and by adding a set of Gradle init-scripts to the Gradle User Home. These will apply to all Gradle executions on the runner, no matter how Gradle is invoked. This means that if you have an existing workflow that executes Gradle with a run step, you can add an initial "Setup Gradle" Step to benefit from caching, build-scan capture and other features of the gradle-build-action.

name: Run Gradle on PRs
on: pull_request
jobs:
  gradle:
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-java@v4
      with:
        distribution: temurin
        java-version: 11
        
    - name: Setup Gradle
      uses: gradle/gradle-build-action@v2
    
    - name: Execute Gradle build
      run: ./gradlew build

Choose a specific Gradle version

The gradle-build-action can download and install a specified Gradle version, adding this installed version to the PATH. Downloaded Gradle versions are stored in the GitHub Actions cache, to avoid requiring downloading again later.

 - uses: gradle/gradle-build-action@v2
   with:
     gradle-version: 6.5

The gradle-version parameter can be set to any valid Gradle version.

Moreover, you can use the following aliases:

Alias	Selects
wrapper	The Gradle wrapper's version (default, useful for matrix builds)
current	The current stable release
release-candidate	The current release candidate if any, otherwise fallback to current
nightly	The latest nightly, fails if none.
release-nightly	The latest release nightly, fails if none.

This can be handy to automatically verify your build works with the latest release candidate of Gradle:

The actual Gradle version used is available as an action output: gradle-version.

name: Test latest Gradle RC
on:
  schedule:
    - cron: 0 0 * * * # daily
jobs:
  gradle-rc:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-java@v4
      with:
        distribution: temurin
        java-version: 11
    - uses: gradle/gradle-build-action@v2
      id: setup-gradle
      with:
        gradle-version: release-candidate
    - run: gradle build --dry-run # just test build configuration
    - run: echo "The release-candidate version was ${{ steps.setup-gradle.outputs.gradle-version }}"

Caching build state between Jobs

The gradle-build-action will use the GitHub Actions cache to save and restore reusable state that may be speed up a subsequent build invocation. This includes most content that is downloaded from the internet as part of a build, as well as expensive to create content like compiled build scripts, transformed Jar files, etc.

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 ;

To reduce the space required for caching, this action makes a best effort to reduce duplication in cache entries.

State will be restored from the cache during the first gradle-build-action step for any workflow job, and cache entries will be written back to the cache at the end of the job, after all Gradle executions have completed.

Disabling caching

Caching is enabled by default. You can disable caching for the action as follows:

cache-disabled: true

Using the cache read-only

By default, the gradle-build-action will only write to the cache from Jobs on the default (main/master) branch. Jobs on other branches will read entries from the cache but will not write updated entries. See Optimizing cache effectiveness for a more detailed explanation.

In some circumstances it makes sense to change this default, and to configure a workflow Job to read existing cache entries but not to write changes back.

You can configure read-only caching for the gradle-build-action as follows:

cache-read-only: true

You can also configure read-only caching only for certain branches:

# Only write to the cache for builds on the 'main' and 'release' branches. (Default is 'main' only.)
# Builds on other branches will only read existing entries from the cache.
cache-read-only: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/release' }}

Using the cache write-only

In certain circumstances it may be desirable to start with a clean Gradle User Home state, but to save that state at the end of a workflow Job:

cache-write-only: true

Overwriting an existing Gradle User Home

When the action detects that the Gradle User Home caches directory already exists (~/.gradle/caches), then by default it will not overwrite the existing content of this directory. This can occur when a prior action initializes this directory, or when using a self-hosted runner that retains this directory between uses.

In this case the Job Summary will display a message like:

Caching for gradle-build-action was disabled due to pre-existing Gradle User Home

If you want override the default and have the gradle-build-action caches overwrite existing content in the Gradle User Home, you can set the cache-overwrite-existing parameter to 'true':

cache-overwrite-existing: true

Saving configuration-cache data

When Gradle is executed with the configuration-cache enabled, the configuration-cache data is stored in the project directory, at <project-dir>/.gradle/configuration-cache. Due to the way the configuration-cache works, this file may contain stored credentials and other secrets, and this data needs to be encrypted in order to be safely stored in the GitHub Actions cache.

In order to benefit from configuration caching in your GitHub Actions workflow, you must:

• Execute your build with Gradle 8.6 or newer. This can be achieved directly, or via the Gradle Wrapper.
• Enable the configuration cache for your build.
• Generate a valid Gradle encryption key and save it as a GitHub Actions secret.
• Provide the secret key via the cache-encryption-key action parameter.

jobs:
  gradle-with-configuration-cache:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: gradle/gradle-build-action@v3
      with:
        gradle-version: 8.6-rc-1
        cache-encryption-key: ${{ secrets.GradleEncryptionKey }}
    - run: gradle build --configuration-cache

Incompatibility with other caching mechanisms

When using gradle-build-action we recommend that you avoid using other mechanisms to save and restore the Gradle User Home.

Specifically:

• Avoid using actions/cache configured to cache the Gradle User Home, as described in this example.
• Avoid using actions/setup-java with the cache: gradle option, as described here.

Using either of these mechanisms may interfere with the caching provided by this action. If you choose to use a different mechanism to save and restore the Gradle User Home, you should disable the caching provided by this action, as described above.

Cache debugging and analysis

A report of all cache entries restored and saved is printed to the Job Summary when saving the cache entries. This report can provide valuable insight into how much cache space is being used.

It is possible to enable additional debug logging for cache operations. You do via the GRADLE_BUILD_ACTION_CACHE_DEBUG_ENABLED environment variable:

env:
  GRADLE_BUILD_ACTION_CACHE_DEBUG_ENABLED: true

Note that this setting will also prevent certain cache operations from running in parallel, further assisting with debugging.

How Gradle User Home caching works

Properties of the GitHub Actions cache

The GitHub Actions cache has some properties that present problems for efficient caching of the Gradle User Home.

• Immutable entries: once a cache entry is written for a key, it cannot be overwritten or changed.
• Branch scope: cache entries written for a Git branch are not visible from actions running against different branches. Entries written for the default branch are visible to all. https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache
• Restore keys: if no exact match is found, a set of partial keys can be provided that will match by cache key prefix. https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#matching-a-cache-key

Each of these properties has influenced the design and implementation of the caching in gradle-build-action, as described below.

Which content is cached

Using experiments and observations, we have attempted to identify which Gradle User Home content is worth saving and restoring between build invocations. We considered both the respective size of the content and the impact this content has on build times. As well as the obvious candidates like downloaded dependencies, we saw that compiled build scripts, transformed Jar files and other content can also have a significant impact.

In the end, we opted to save and restore as much content as is practical, including:

• caches/<version>/generated-gradle-jars: These files are generated on first use of a particular Gradle version, and are expensive to recreate
• caches/<version>/kotlin-dsl and caches/<version>/scripts: These are the compiled build scripts. The Kotlin ones in particular can benefit from caching.
• caches/modules-2: The downloaded dependencies
• caches/transforms-3: The results of artifact transforms
• caches/jars-9: Jar files that have been processed/instrumented by Gradle
• caches/build-cache-1: The local build cache

In certain cases a particular section of Gradle User Home will be too large to make caching effective. In these cases, particular subdirectories can be excluded from caching. See Exclude content from Gradle User Home cache.

Cache keys

The actual content of the Gradle User Home after a build is the result of many factors, including:

• Core Gradle build files (settings.gradle[.kts], build.gradle[.kts], gradle.properties)
• Associated Gradle configuration files (gradle-wrapper.properties, dependencies.toml, etc)
• The entire content of buildSrc or any included builds that provide plugins.
• The entire content of the repository, in the case of the local build cache.
• The actual build command that was invoked, including system properties and environment variables.

For this reason, it's very difficult to create a cache key that will deterministically map to a saved Gradle User Home state. So instead of trying to reliably hash all of these inputs to generate a cache key, the Gradle User Home cache key is based on the currently executing Job and the current commit hash for the repository.

The Gradle User Home cache key is composed of:

• The current operating system (RUNNER_OS)
• The workflow name and Job ID
• A hash of the Job matrix parameters
• The git SHA for the latest commit

Specifically, the cache key is: ${cache-protocol}-gradle|${runner-os}|${workflow-name}-${job-id}[${hash-of-job-matrix}]-${git-sha}

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.

Finding a matching cache entry

In most cases, no exact match will exist for the cache key. Instead, the Gradle User Home will be restored for the closest matching cache entry, using a set of "restore keys". The entries will be matched with the following precedence:

• An exact match on OS, workflow name, job id, matrix and Git SHA
• The most recent entry saved for the same OS, workflow name, job id and matrix values
• The most recent entry saved for the same OS and job id
• The most recent entry saved for the same OS

Due to branch scoping of cache entries, the above match will be first performed for entries from the same branch, and then for the default ('main') branch.

After the Job is complete, the current Gradle User Home state will be collected and written as a new cache entry with the complete cache key. Old entries will be expunged from the GitHub Actions cache on a least-recently-used basis.

Note that while effective, this mechanism is not inherently efficient. It requires the entire Gradle User Home directory to be stored separately for each branch, for every OS+Job+Matrix combination. In addition, a new cache entry to be written on every GitHub Actions run.

This inefficiency is effectively mitigated by Deduplication of Gradle User Home cache entries, and can be further optimized for a workflow using the techniques described in Optimizing cache effectiveness.

Deduplication of Gradle User Home cache entries

To reduce duplication between cache entries, certain artifacts in Gradle User Home are extracted and cached independently based on their identity. This allows each Gradle User Home cache entry to be relatively small, sharing common elements between them without duplication.

Artifacts that are cached independently include:

• Downloaded dependencies
• Downloaded wrapper distributions
• Generated Gradle API jars
• Downloaded Java Toolchains

For example, this means that all jobs executing a particular version of the Gradle wrapper will share a single common entry for this wrapper distribution and one for each of the generated Gradle API jars.

Stopping the Gradle daemon

By default, the action will stop all running Gradle daemons in the post-action step, prior to saving the Gradle User Home state. This allows for any Gradle User Home cleanup to occur, and avoid file-locking issues on Windows.

If caching is disabled or the cache is in read-only mode, the daemon will not be stopped and will continue running after the job is completed.

Optimizing cache effectiveness

Cache storage space for GitHub actions is limited, and writing new cache entries can trigger the deletion of existing entries. Eviction of shared cache entries can reduce cache effectiveness, slowing down your gradle-build-action steps.

There are a number of actions you can take if your cache use is less effective due to entry eviction.

At the end of a Job, the gradle-build-action will write a summary of the Gradle builds executed, together with a detailed report of the cache entries that were read and written during the Job. This report can provide valuable insights that may help to determine the right way to optimize the cache usage for your workflow.

Select which jobs should write to the cache

Consider a workflow that first runs a Job "compile-and-unit-test" to compile the code and run some basic unit tests, which is followed by a matrix of parallel "integration-test" jobs that each run a set of integration tests for the repository. Each "integration test" Job requires all of the dependencies required by "compile-and-unit-test", and possibly one or 2 additional dependencies.

By default, a new cache entry will be written on completion of each integration test job. If no additional dependencies were downloaded then this cache entry will share the "dependencies" entry with the "compile-and-unit-test" job, but if a single dependency was downloaded then an entire new "dependencies" entry would be written. (The gradle-build-action does not yet support a layered cache that could do this more efficiently). If each of these "integration-test" entries with their different "dependencies" entries is too large, then it could result in other important entries being evicted from the GitHub Actions cache.

There are some techniques that can be used to avoid/mitigate this issue:

• Configure the "integration-test" jobs with cache-read-only: true, meaning that the Job will use the entry written by the "compile-and-unit-test" job. This will avoid the overhead of cache entries for each of these jobs, at the expense of re-downloading any additional dependencies required by "integration-test".
• Add an additional step to the "compile-and-unit-test" job which downloads all dependencies required by the integration-test jobs but does not execute the tests. This will allow the "dependencies" entry for "compile-and-unit-test" to be shared among all cache entries for "integration-test". The resulting "integration-test" entries should be much smaller, reducing the potential for eviction.
• Combine the above 2 techniques, so that no cache entry is written by "integration-test" jobs, but all required dependencies are already present from the restored "compile-and-unit-test" entry.

Select which branches should write to the cache

GitHub cache entries are not shared between builds on different branches. Workflow runs can restore caches created in either the current branch or the default branch (usually main). This means that each branch will have it's own Gradle User Home cache scope, and will not benefit from cache entries written for other (non-default) branches.

By default, the gradle-build-action will only write to the cache for builds run on the default (master/main) branch. Jobs run on other branches will only read from the cache. In most cases, this is the desired behavior. This is because Jobs run on other branches will benefit from the cache Gradle User Home from main, without writing private cache entries that which could lead to evicting these shared entries.

If you have other long-lived development branches that would benefit from writing to the cache, you can configure this by disabling the cache-read-only action parameter for these branches. See Using the cache read-only for more details.

Note there are some cases where writing cache entries is typically unhelpful (these are disabled by default):

• For pull_request triggered runs, the cache scope is limited to the merge ref (refs/pull/.../merge) and can only be restored by re-runs of the same pull request.
• For merge_group triggered runs, the cache scope is limited to a temporary branch with a special prefix created to validate pull request changes, and won't be available on subsequent Merge Queue executions.

Exclude content from Gradle User Home cache

As well as any wrapper distributions, the action will attempt to save and restore the caches and notifications directories from Gradle User Home.

Each build is different, and some builds produce more Gradle User Home content than others. Cache debugging can provide insight into which cache entries are the largest, and the contents to be cached can be fine tuned by including and excluding certain paths within Gradle User Home.

# Cache downloaded JDKs in addition to the default directories.
gradle-home-cache-includes: |
    caches
    notifications
    jdks    
# 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. File pattern support is documented at https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#patterns-to-match-file-paths.

Remove unused files from Gradle User Home before saving to cache

The Gradle User Home directory has a tendency to grow over time. When you switch to a new Gradle wrapper version or upgrade a dependency version the old files are not automatically and immediately removed. While this can make sense in a local environment, in a GitHub Actions environment it can lead to ever-larger Gradle User Home cache entries being saved and restored.

In order to avoid this situation, the gradle-build-action supports the gradle-home-cache-cleanup parameter. When enabled, this feature will attempt to delete any files in the Gradle User Home that were not used by Gradle during the GitHub Actions workflow, prior to saving the Gradle User Home to the GitHub Actions cache.

Gradle Home cache cleanup is considered experimental and is disabled by default. You can enable this feature for the action as follows:

gradle-home-cache-cleanup: true

Build reporting

The gradle-build-action collects information about any Gradle executions that occur in a workflow, including the root project, requested tasks, build outcome and any Build Scan link generated. Details of cache entries read and written are also collected. These details are compiled into a Job Summary, which is visible in the GitHub Actions UI.

Generation of a Job Summary is enabled by default for all Jobs using the gradle-build-action. This feature can be configured so that a Job Summary is never generated, or so that a Job Summary is only generated on build failure:

add-job-summary: 'on-failure' # Valid values are 'always' (default), 'never', and 'on-failure'

Adding Job Summary as a Pull Request comment

It is sometimes more convenient to view the results of a GitHub Actions Job directly from the Pull Request that triggered the Job. For this purpose you can configure the action so that Job Summary data is added as a Pull Request comment.

name: CI
on:
  pull_request:

permissions:
  pull-requests: write

jobs:
  run-gradle-build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout project sources
      uses: actions/checkout@v4
    - name: Setup Gradle
      uses: gradle/gradle-build-action@v3
      with:
        add-job-summary-as-pr-comment: on-failure # Valid values are 'never' (default), 'always', and 'on-failure'
    - run: ./gradlew build --scan

Note that in order to add a Pull Request comment, the workflow must be configured with the pull-requests: write permission.

Build Scan® link as Step output

As well as reporting all Build Scan links in the Job Summary, the gradle-build-action action makes this link available an an output of any Step that executes Gradle.

The output name is build-scan-url. You can then use the build scan link in subsequent actions of your workflow.

Saving arbitrary build outputs

By default, a GitHub Actions workflow using gradle-build-action will record the log output and any Build Scan links for your build, but any output files generated by the build will not be saved.

To save selected files from your build execution, you can use the core Upload-Artifact action. For example:

jobs:   
  gradle:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout project sources
      uses: actions/checkout@v4
    - name: Setup Gradle
      uses: gradle/gradle-build-action@v2
    - name: Run build with Gradle wrapper
      run: ./gradlew build --scan
    - name: Upload build reports
      uses: actions/upload-artifact@v3
      if: always()
      with:
        name: build-reports
        path: build/reports/

Use of custom init-scripts in Gradle User Home

Note that the action collects information about Gradle invocations via an Initialization Script located at USER_HOME/.gradle/init.d/gradle-build-action.build-result-capture.init.gradle.

If you are adding any custom init scripts to the USER_HOME/.gradle/init.d directory, it may be necessary to ensure these files are applied prior to gradle-build-action.build-result-capture.init.gradle. Since Gradle applies init scripts in alphabetical order, one way to ensure this is via file naming.

Support for GitHub Enterprise Server (GHES)

You can use the gradle-build-action on GitHub Enterprise Server, and benefit from the improved integration with Gradle. Depending on the version of GHES you are running, certain features may be limited:

• Build Scan links are captured and displayed in the GitHub Actions UI
• Easily run your build with different versions of Gradle
• Save/restore of Gradle User Home (requires GHES v3.5+ : GitHub Actions cache was introduced in GHES 3.5)
• Support for GitHub Actions Job Summary (requires GHES 3.6+ : GitHub Actions Job Summary support was introduced in GHES 3.6). In earlier versions of GHES the build-results summary and caching report will be written to the workflow log, as part of the post-action step.

GitHub Dependency Graph support

The gradle-build-action has support for submitting a GitHub Dependency Graph snapshot via the GitHub Dependency Submission API.

The dependency graph snapshot is generated via integration with the GitHub Dependency Graph Gradle Plugin, and saved as a workflow artifact. The generated snapshot files can be submitted either in the same job, or in a subsequent job (in the same or a dependent workflow).

The generated dependency graph snapshot reports all of the dependencies that were resolved during a build execution, and is used by GitHub to generate Dependabot Alerts for vulnerable dependencies, as well as to populate the Dependency Graph insights view.

Enable Dependency Graph generation for a workflow

You enable GitHub Dependency Graph support by setting the dependency-graph action parameter. Valid values are:

Option	Behaviour
disabled	Do not generate a dependency graph for any build invocations. This is the default.
generate	Generate a dependency graph snapshot for each build invocation, saving as a workflow artifact.
generate-and-submit	As per generate, but any generated dependency graph snapshots will be submitted at the end of the job.
download-and-submit	Download any previously saved dependency graph snapshots, submitting them via the Dependency Submission API. This can be useful to collect all snapshots in a matrix of builds and submit them in one step.

Example of a CI workflow that generates and submits a dependency graph:

name: CI build
on:
  push:
  
permissions:
  contents: write

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Setup Gradle to generate and submit dependency graphs
      uses: gradle/gradle-build-action@v2
      with:
        dependency-graph: generate-and-submit
    - name: Run the usual CI build (dependency-graph will be generated and submitted post-job)
      run: ./gradlew build

The contents: write permission is required in order to submit (but not generate) the dependency graph file. Depending on repository settings, this permission may be available by default or may need to be explicitly enabled in the workflow file (as above).

Important

The above configuration will work for workflows that run as a result of commits to a repository branch, but not when a workflow is triggered by a PR from a repository fork. This is because the contents: write permission is not available when executing a workflow for a PR submitted from a forked repository. For a configuration that supports this setup, see Dependency Graphs for pull request workflows.

Using a custom plugin repository

By default, the action downloads the github-dependency-graph-gradle-plugin from the Gradle Plugin Portal (https://plugins.gradle.org). If your GitHub Actions environment does not have access to this URL, you can specify a custom plugin repository to use. Do so by setting the GRADLE_PLUGIN_REPOSITORY_URL environment variable with your Gradle invocation.

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Setup Gradle to generate and submit dependency graphs
      uses: gradle/gradle-build-action@v2
      with:
        dependency-graph: generate-and-submit
    - name: Run a build, resolving the 'dependency-graph' plugin from the plugin portal proxy
      run: ./gradlew build
      env:
        GRADLE_PLUGIN_REPOSITORY_URL: "https://gradle-plugins-proxy.mycorp.com"

Integrating the dependency-review-action

The GitHub dependency-review-action helps you understand dependency changes (and the security impact of these changes) for a pull request. For the dependency-review-action to succeed, it must run after the dependency graph has been submitted for a PR.

When using generate-and-submit, dependency graph files are submitted at the end of the job, after all steps have been executed. For this reason, the dependency-review-action must be executed in a dependent job, and not as a subsequent step in the job that generates the dependency graph.

Example of a pull request workflow that executes a build for a pull request and runs the dependency-review-action:

name: PR check

on:
  pull_request:
  
permissions:
  contents: write
  # Note that this permission will not be available if the PR is from a forked repository

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Setup Gradle to generate and submit dependency graphs
      uses: gradle/gradle-build-action@v2
      with:
        dependency-graph: generate-and-submit
    - name: Run a build and generate the dependency graph which will be submitted post-job
      run: ./gradlew build

  dependency-review:
    needs: build
    runs-on: ubuntu-latest
    - name: Perform dependency review
      uses: actions/dependency-review-action@v3

See Dependency Graphs for pull request workflows for a more complex (and less functional) example that will work for pull requests submitted from forked repositories.

Limiting the scope of the dependency graph

At times it is helpful to limit the dependencies reported to GitHub, in order to security alerts for dependencies that don't form a critical part of your product. For example, a vulnerability in the tool you use to generate documentation is unlikely to be as important as a vulnerability in one of your runtime dependencies.

There are a number of techniques you can employ to limit the scope of the generated dependency graph:

• Don't generate a dependency graph for all Gradle executions
• For a Gradle execution, filter which Gradle projects and configurations will contribute dependencies
• Use a separate workflow that only resolves the required dependencies

Note

Ideally, all dependencies involved in building and testing a project will be extracted and reported in a dependency graph. These dependencies would be assigned to different scopes (eg development, runtime, testing) and the GitHub UI would make it easy to opt-in to security alerts for different dependency scopes. However, this functionality does not yet exist.

Choosing which Gradle invocations will generate a dependency graph

Once you enable the dependency graph support for a workflow job (via the dependency-graph parameter), dependencies will be collected and reported for all subsequent Gradle invocations. If you have a Gradle build step that you want to exclude from dependency graph generation, you can set the GITHUB_DEPENDENCY_GRAPH_ENABLED environment variable to false.

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Setup Gradle to generate and submit dependency graphs
      uses: gradle/gradle-build-action@v2
      with:
        dependency-graph: generate-and-submit
    - name: Build the app, generating a graph of dependencies required
      run: ./gradlew :my-app:assemble
    - name: Run all checks, disabling dependency graph generation
      run: ./gradlew check
      env:
        GITHUB_DEPENDENCY_GRAPH_ENABLED: false

Filtering which Gradle Configurations contribute to the dependency graph

If you do not want the dependency graph to include every dependency configuration in every project in your build, you can limit the dependency extraction to a subset of these.

To restrict which Gradle subprojects contribute to the report, specify which projects to include via a regular expression. You can provide this value via the DEPENDENCY_GRAPH_INCLUDE_PROJECTS environment variable or system property.

To restrict which Gradle configurations contribute to the report, you can filter configurations by name using a regular expression. You can provide this value via the DEPENDENCY_GRAPH_INCLUDE_CONFIGURATIONS environment variable or system property.

For example, if you want to exclude dependencies in the buildSrc project, and only report on dependencies from the runtimeClasspath configuration, you would use the following configuration:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Setup Gradle to generate and submit dependency graphs
      uses: gradle/gradle-build-action@v2
      with:
        dependency-graph: generate-and-submit
    - name: Run a build, generating the dependency graph from any resolved 'runtimeClasspath' configurations
      run: ./gradlew build
      env:
        DEPENDENCY_GRAPH_INCLUDE_PROJECTS: "^:(?!buildSrc).*"
        DEPENDENCY_GRAPH_INCLUDE_CONFIGURATIONS: runtimeClasspath

Use a dedicated workflow for dependency graph generation

Instead of generating a dependency graph from your existing CI workflow, it's possible to create a separate dedicated workflow (or Job) that is intended for generating a dependency graph. Such a workflow will still need to execute Gradle, but can do so in a way that is targeted at resolving the specific dependencies required.

For example, the following workflow will report those dependencies that are resolved in order to build the distributionZip for the my-app project. Test dependencies and other dependencies not required by the distributionZip will not be included.

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Setup Gradle to generate and submit dependency graphs
      uses: gradle/gradle-build-action@v2
      with:
        dependency-graph: generate-and-submit
    - name: Build the distribution Zip for `my-app`
      run: ./gradlew :my-app:distributionZip

Note that the above example will also include any buildSrc dependencies, dependencies resolved when configuring your Gradle build or dependencies resolved while applying plugin. All of these dependencies are resolved in the process of running the distributionZip task, and thus will form part of the generated dependency graph.

If this isn't desirable, you will still need to use the filtering mechanism described above.

Dependency Graphs for pull request workflows

This contents: write permission is not available for any workflow that is triggered by a pull request submitted from a forked repository, since it would permit a malicious pull request to make repository changes.

Because of this restriction, it is not possible to generate-and-submit a dependency graph generated for a pull-request that comes from a repository fork. In order to do so, 2 workflows will be required:

1. The first workflow runs directly against the pull request sources and will generate the dependency graph snapshot.
2. The second workflow is triggered on workflow_run of the first workflow, and will submit the previously saved dependency snapshots.

Note: when download-and-submit is used in a workflow triggered via workflow_run, the action will download snapshots saved in the triggering workflow.

Main workflow file

name: run-build-and-generate-dependency-snapshot

on:
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Setup Gradle to generate and submit dependency graphs
      uses: gradle/gradle-build-action@v2
      with:
        dependency-graph: generate # Only generate in this job
    - name: Run a build, generating the dependency graph snapshot which will be submitted
      run: ./gradlew build

Dependent workflow file

name: submit-dependency-snapshot

on:
  workflow_run:
    workflows: ['run-build-and-generate-dependency-snapshot']
    types: [completed]

jobs:
  submit-dependency-graph:
    runs-on: ubuntu-latest
    steps:
    - name: Retrieve dependency graph artifact and submit
      uses: gradle/gradle-build-action@v2
      with:
        dependency-graph: download-and-submit

Integrating dependency-review-action for pull request workflows

The GitHub dependency-review-action helps you understand dependency changes (and the security impact of these changes) for a pull request.

To integrate the dependency-review-action into the pull request workflows above, a separate workflow should be added. This workflow will be triggered directly on pull_request, but will need to wait until the dependency graph results are submitted before the dependency review can complete. How long to wait is controlled by the retry-on-snapshot-warnings input parameters.

Here's an example of a separate "Dependency Review" workflow that will wait for 10 minutes for the PR check workflow to complete.

name: dependency-review
on:
  pull_request:

permissions:
  contents: read
  pull-requests: write

jobs:
  dependency-review:
    runs-on: ubuntu-latest
    steps:
    - name: 'Dependency Review'
      uses: actions/dependency-review-action@v3
      with:
        retry-on-snapshot-warnings: true
        retry-on-snapshot-warnings-timeout: 600

The retry-on-snapshot-warnings-timeout (in seconds) needs to be long enough to allow the entire run-build-and-generate-dependency-snapshot and submit-dependency-snapshot workflows (above) to complete.

Gradle version compatibility

The GitHub Dependency Graph plugin should be compatible with all versions of Gradle >= 5.0, and has been tested against Gradle versions "5.6.4", "6.9.4", "7.0.2", "7.6.2", "8.0.2" and the current Gradle release.

The plugin is compatible with running Gradle with the configuration-cache enabled. However, this support is limited to Gradle "8.1.0" and later:

• With Gradle "8.0", the build should run successfully, but an empty dependency graph will be generated.
• With Gradle <= "7.6.4", the plugin will cause the build to fail with configuration-cache enabled.

To use this plugin with versions of Gradle older than "8.1.0", you'll need to invoke Gradle with the configuration-cache disabled.

Reducing storage costs for saved dependency graph artifacts

When generate or generate-and-submit is used with the action, the dependency graph that is generated is stored as a workflow artifact. By default, these artifacts are retained for a period of 30 days (or as configured for the repository). To reduce storage costs for these artifacts, you can set the artifact-retention-days value to a lower number.

    steps:
    - name: Generate dependency graph, but only retain artifact for one day
      uses: gradle/gradle-build-action@v2
      with:
        dependency-graph: generate
        artifact-retention-days: 1

Gradle Enterprise plugin injection

The gradle-build-action provides support for injecting and configuring the Gradle Enterprise Gradle plugin into any Gradle build, without any modification to the project sources. This is achieved via an init-script installed into Gradle User Home, which is enabled and parameterized via environment variables.

The same auto-injection behavior is available for the Common Custom User Data Gradle plugin, which enriches any build scans published with additional useful information.

Enabling Gradle Enterprise injection

In order to enable Gradle Enterprise for your build, you must provide the required configuration via environment variables.

Here's a minimal example:

name: Run build with Gradle Enterprise injection
  
env:
  GRADLE_ENTERPRISE_INJECTION_ENABLED: true
  GRADLE_ENTERPRISE_URL: https://ge.gradle.org
  GRADLE_ENTERPRISE_PLUGIN_VERSION: 3.16.1
  GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GE_ACCESS_KEY }} # Required to publish scans to ge.gradle.org

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Setup Gradle
      uses: gradle/gradle-build-action@v2
    - name: Run a Gradle build with Gradle Enterprise injection enabled
      run: ./gradlew build

This configuration will automatically apply v3.16.1 of the Gradle Enterprise Gradle plugin, and publish build scans to https://ge.gradle.org.

Note that the ge.gradle.org server requires authentication in order to publish scans. The provided GRADLE_ENTERPRISE_ACCESS_KEY isn't required by the Gradle Enterprise injection script, but will be used by the GE plugin in order to authenticate with the server.

Configuring Gradle Enterprise injection

The init-script supports a number of additional configuration parameters that you may fine useful. All configuration options (required and optional) are detailed below:

Variable	Required	Description
GRADLE_ENTERPRISE_INJECTION_ENABLED	✅	enables Gradle Enterprise injection
GRADLE_ENTERPRISE_URL	✅	the URL of the Gradle Enterprise server
GRADLE_ENTERPRISE_ALLOW_UNTRUSTED_SERVER		allow communication with an untrusted server; set to true if your Gradle Enterprise instance is using a self-signed certificate
GRADLE_ENTERPRISE_ENFORCE_URL		enforce the configured Gradle Enterprise URL over a URL configured in the project's build; set to true to enforce publication of build scans to the configured Gradle Enterprise URL
GRADLE_ENTERPRISE_PLUGIN_VERSION	✅	the version of the Gradle Enterprise Gradle plugin to apply
GRADLE_ENTERPRISE_CCUD_PLUGIN_VERSION		the version of the Common Custom User Data Gradle plugin to apply, if any
GRADLE_ENTERPRISE_PLUGIN_REPOSITORY_URL		the URL of the repository to use when resolving the GE and CCUD plugins; the Gradle Plugin Portal is used by default

Publishing to scans.gradle.com

Gradle Enterprise injection is designed to enable publishing of build scans to a Gradle Enterprise instance, and is not suitable for publishing to the public Build Scans instance (https://scans.gradle.com).

In order to publish Build Scans to scans.gradle.com, you need to:

• Apply the Gradle Enterprise plugin to your build configuration (see docs)
• Programmatically accept the Terms of Service for scans.gradle.com (see docs)
• Execute the build with --scan or configure your build with publishAlways() (see docs)