Gradle Plugin to automatically upgrade your java gradle project dependencies and send a GitHub pull request with the changes.
- Apply and configure the plugin according to your needs
- Invoke the
upgradeDependencies
task on your CI tool (daily, weekly, monthly, as you wish) - If any of your dependencies is out-of-date, the plugin will create a pull request to update it.
- Verify that your PR CI checks pass, scan the included release notes, perform manual tests, and merge the PR.
- Automatic Pull Request creation, including useful information whenever available:
- new version release notes link
- library documentation link
- library source code link
- library issue tracker link
- library size
- new permissions added by the library (only for android libraries)
- Support to configure which dependencies include and exclude, where to find their definitions, how many pull requests create and more.
- Support any java based project using Gradle.
Add the following configuration to your root build.gradle
, replacing X.Y.Z by the latest version
Using the plugins DSL:
plugins {
id "com.releaseshub.gradle.plugin" version "X.Y.Z"
}
Using legacy plugin application:
buildscript {
repositories {
mavenCentral() // or gradlePluginPortal()
}
dependencies {
classpath("com.releaseshub:releases-hub-gradle-plugin:X.Y.Z")
}
}
apply plugin: "com.releaseshub.gradle.plugin"
All the plugin configuration properties can be added using any of the following ways:
- Using the
releasesHub
extension on the build.gradle. For example:
releasesHub {
gitHubWriteToken = "123"
}
- As a command line parameter. For example:
./gradlew listDependencies -PgitHubWriteToken=123
- As a property on a
gradle.properties
file. For example:
gitHubWriteToken = "123"
- As an extra property on the build.gradlee. For example:
ext.gitHubWriteToken = "123"
- As a System Environment property
The base path for the class names where the dependencies are defined. The default value is buildSrc/src/main/kotlin/
. This property is required
dependenciesBasePath = "buildSrc/src/main/kotlin/"
The class names where the dependencies are defined. The default value is ["Libs.kt", "BuildLibs.kt"]
. This property is required
dependenciesClassNames = ["Libs.kt", "BuildLibs.kt"]
The dependencies to include.
You can define a groupId
to match all the artifacts for that group id, or groupId:artifactId
to match a particular artifact.
By default all the dependencies found on dependenciesClassNames
are included.
includes = ["com.groupid1", "com.groupid2:artifact1"]
The dependencies to exclude.
You can define a groupId
to match all the artifacts for that group id, or groupId:artifactId
to match a particular artifact.
By default there aren't excluded dependencies.
excludes = ["com.groupid1", "com.groupid2:artifact1"]
If you need to exclude the Gradle upgrade, use "gradle". For example:
excludes = ["gradle"]
This project uses the Semantic Versioning guidelines for transparency into our release cycle.
We suggest to define your dependencies on /buildSrc/src/main/kotlin/Libs.kt
and /buildSrc/src/main/kotlin/BuildLibs.kt
classes. For example:
object Libs {
const val KOTLIN = "org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.3.40"
}
object BuildLibs {
const val KOTLIN_PLUGIN = "org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.41"
}
apply plugin: "kotlin"
apply plugin: "com.releaseshub.gradle.plugin"
buildscript {
dependencies {
classpath(BuildLibs.KOTLIN_PLUGIN)
}
}
dependencies {
compile(Libs.KOTLIN)
}
See the sample for more details.
Validate all the dependencies. The following validations are executed:
- All the dependencies defined on each
dependenciesClassNames
are sorted alphabetically bygroupId:artifactId
- There are not duplicated dependencies defined on each
dependenciesClassNames
- There are not dependencies with snapshot or dynamic versions assigned
- There are dependencies on
dependenciesClassNames
but not used on the project - There are declared dependencies on any build.gradle but not defined on
dependenciesClassNames
classes
./gradlew validateDependencies
The dependencies to exclude from the unused validation.
You can define a groupId
to match all the artifacts for that group id, or groupId:artifactId
to match a particular artifact.
By default there aren't excluded dependencies.
unusedExcludes = ["com.groupid1", "com.groupid2:artifact1"]
The file extensions of the files where the artifact's packages will we search to find unused dependendencies.
By default [".kt", ".java", ".xml"]
unusedExtensionsToSearch = [".kt", ".java"]
Print all the dependencies that will be analyzed to upgrade.
./gradlew listDependencies
Print all the dependencies that are upgradeable. A file build/releasesHub/dependencies_to_upgrade_count.txt
is generated with the count of dependencies that are upgradeable. This could be useful for metrics.
./gradlew listDependenciesToUpgrade
This task creates a Github Pull Request for each groupId that have at least one dependency to upgrade.
The following steps are executed for each groupId
:
- Creates the
headBranch
(headBranchPrefix
+groupId
) (if not exists) - Merge from the
baseBranch
to theheadBranch
- Upgrade all the dependencies defined on the
dependenciesClassNames
for thegroupId
- Create a commit for each dependency upgraded
- Push the previous commits to the
headBranch
- Create a GitHub pull request from the
headBranch
to thebaseBranch
./gradlew upgradeDependencies
Whether a pull request with all the upgrades should be created or not. The default value is false
pullRequestEnabled = true
The maximum amount of pull requests to create during the task execution.
This is useful to avoid creating too much pull requests when you still have many dependencies to upgrade. The default value is 5
pullRequestsMax = 10
The list of labels to assign when creating the pull request. Optional list.
pullRequestLabels = ["dependencies"]
The list of reviewers to assign when creating the pull request. Optional list.
pullRequestReviewers = ["octocat", "hubot", "other_user"]
The list of team reviewers to assign when creating the pull request. Optional list.
pullRequestTeamReviewers = ["justice-league"]
The branch's prefix where the commit will be pushed. Also, the head branch's prefix of the pull request to create. Required String (only if pullRequestEnabled
is true
). The default value is releases_hub/
.
headBranchPrefix = "branch_name_"
The pull request base branch. Optional String. The default value is master
.
baseBranch = "master"
The GitHub user name used by the commit command. Optional String.
gitHubUserName = "user"
The GitHub user email used by the commit command. Optional String.
gitHubUserEmail = "email@mail.com"
The GitHub repository owner where the pull request will be created. Required String (only if pullRequestEnabled
is true
).
gitHubRepositoryOwner = "repo_owner"
The GitHub repository name where the pull request will be created. Required String (only if pullRequestEnabled
is true
).
gitHubRepositoryName = "repo_name"
The GitHub write token needed to access the GitHub API to create the pull request.
We strongly recommend to not use the releasesHub
extension for this property, to avoid exposing it on the git repository.
Required String (only if pullRequestEnabled
is true
).
gitHubWriteToken = "123"
The GitHub api host name needed to access the GitHub Enterprise. Optional String.
gitHubApiHostName = "your.githubenterprise.com"
The listDependenciesToUpgrade
& upgradeDependencies
tasks send to Releases Hub servers the groupId, artifactId and version of the project dependencies, in order to process and fetch the artifacts updates.
That information is sent using SSL and it is NOT stored on the servers. The dependencies excluded through the plugin configuration are not send to the servers.
Donations are greatly appreciated. You can help us to pay for our domain & cloud backend, both needed to provide you the latest libraries upgrades.
http://donations.releaseshub.com/
Follow us on Twitter