Gradle Wrapper Upgrade

A GitHub action to upgrade the gradle wrapper of your project.

This action will check for the newest gradle version and upgrade the gradle wrapper properties and the wrapper.

Usage

Run this action scheduled and create a PR afterwards to review the made changes.

    steps:
      - name: checkout
        uses: actions/checkout@v2

      - name: update gradle
        id: gradleUpdate
        uses: EdwarDDay/upgrade-gradle-action@v1

     # create PR

You can use whatever PR creation action you want to customize the PR.

This action doesn't check the integrity of the downloaded wrapper. Please use gradle/wrapper-validation-action for a validation check.

Action Input

All inputs are optional

Name	Description	Possible values	Default
distribution-type	The distribution type used in the gradle wrapper task.	bin, all, default	default (doesn't specify the distribution type in the gradle wrapper task)
release-channel	The release channel used from which the latest gradle version is fetched.	current, release-candidate, nightly, release-nightly	current
working-directoy	The directory with the gradlew file.	any directory	./
add-sha-sum	Whether to add the distribution checksum or not. Only valid, if distribution type is explicitly set.	false, true	false

Action Output

Name	Description	Example values
gradle-version	The defined gradle version in the gradle wrapper task.	6.8.3, 7.0, 7.1-20210410220511+0000
version-information	Version information of the gradle-version, which can be used in a PR body	Upgrade to latest gradle version 7.0 fixed issues - #16593 Dependency locking of settings classpath isn't properly persisted - ... known issues - #16665 Version Catalog + Extensions - ...
fixed-issues	The fixed issues of the gradle-version (can be empty)	- #16593 Dependency locking of settings classpath isn't properly persisted - #16585 Upgrade Bouncy Castle dependency - ...
known-issues	The known issues of the gradle-version (can be empty)	- #16665 Version Catalog + Extensions - #16652 Trouble using centralized dependency versions in buildSrc plugins and buildscript classpath - ...
sha-256-sum	The distribution sha 256 sum (if add-sha-sum is set, else empty)	31c55713e40233a8303827ceb42ca48a47267a0ad4bab9177123121e71524c26

Example

name: Gradle wrapper update

on:
  schedule:
    - cron: '0 6 * * *'

jobs:
  update:
    runs-on: ubuntu-24.04

    steps:
      - name: checkout
        uses: actions/checkout@v4

      - name: update gradle
        id: gradleUpdate
        uses: EdwarDDay/upgrade-gradle-action@v1

      - name: create pull request
        uses: peter-evans/create-pull-request@v7
        with:
          commit-message: "Update gradle to ${{ steps.gradleUpdate.outputs.gradle-version }}"
          branch: "gradle_update/version_${{ steps.gradleUpdate.outputs.gradle-version }}"
          delete-branch: true
          title: "Update gradle to ${{ steps.gradleUpdate.outputs.gradle-version }}"
          body: |
            ${{ steps.gradleUpdate.outputs.version-information }}

            Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
          labels: "dependencies,gradle"