Maven-auto-upgrade-script

Maven auto upgrade script to auto-generate GitHub pull requests with version upgrades.

View project on GitHub

maven-auto-upgrade-script

License

Maven auto upgrade script check for any existing maven dependency and/or plugin upgrade. For each upgrade, a new branch is created with a single upgrade and a pull request is submitted from this branch.

Installation

Clone the git repository with this command:

git clone https://github.com/Yomoni/maven-auto-upgrade-script.git

Requirements

  • git must be installed, version 2.3 or above is recommended
  • Maven must be installed and the mvn command must works (in the PATH environment variable with the associated JAVA_HOME/JDK)
  • hub must be installed and configured to generate pull-request directly in GitHub

Launch

Single repository check

Check of dependencies upgrades on a remote git repository (with a temporary clone) or a local existing one can be done with this command:

maven-auto-upgrade.sh <git repository URL|git repository local directory> [<target branch>]

If no target branch is specified, the default branch master is used. If the repository already exists, no bash git pull command is used to synchronize the repository.

Execution example command:

maven-auto-upgrade.sh https://github.com/Sylvain-Bugat/RundeckMonitor.git

output of this example:

Verifying Git version:...[OK] -> git version 2.7.0
Verifying GitHub Hub version:...[OK] found hub command -> hub version 2.2.2
Verifying Maven version:...[OK] -> Apache Maven 3.3.3
Cloning Sylvain-Bugat/RundeckMonitor repository:...[OK]
Checking property version upgrades:...[OK] -> 1 upgrade(s) found

Upgrading slf4j.version property from 1.7.18 to 1.7.19
Checkout of main branch master:...[OK]
Checking existence of the remote slf4j.version_upgrade_1.7.18_to_1.7.19:...[OK]
Modifying property assertj.version:...[OK]
Create and checkout branch slf4j.version_upgrade_1.7.18_to_1.7.19:...[OK]
Adding modified pom.xml to commit files:...[OK]
Commiting modified pom.xml files:...[OK]
Pushing the commit to the git repository:...[OK]
Creating the associated GitHub pull-request:...[OK] -> https://github.com/Sylvain-Bugat/RundeckMonitor/pull/33
Deleting clone /cygdrive/c/maven-auto-upgrade-script/RundeckMonitor:...[OK]

Created pull request on this example: https://github.com/Sylvain-Bugat/RundeckMonitor/pull/33

Multiple repository check

The check of multiple existing/remote git repositories can be done with this command:

maven-multi-repository-auto-upgrade.sh <git repository URL|git directory> [<git repository URL|git directory>] [...]

In multiple repositories check, the default branche master is used

Execution example command:

maven-multi-repository-auto-upgrade.sh https://github.com/Sylvain-Bugat/RundeckMonitor.git https://github.com/Sylvain-Bugat/aws-ec2-start-stop-tools.git

Command output exemple:

Verifying Git version:...[OK] -> git version 2.7.0
Verifying GitHub Hub version:...[OK] found hub command -> hub version 2.2.2
Verifying Maven version:...[OK] -> Apache Maven 3.3.3

Check Maven dependencies upgrades of https://github.com/Sylvain-Bugat/RundeckMonitor.git repository
Cloning Sylvain-Bugat/RundeckMonitor repository:...[OK]
Checking property version upgrades:...[OK] -> 0 upgrade(s) found
Deleting clone /cygdrive/c/maven-auto-upgrade-script/RundeckMonitor directory:...[OK]

Check Maven dependencies upgrades of https://github.com/Sylvain-Bugat/aws-ec2-start-stop-tools.git repository
Cloning Sylvain-Bugat/aws-ec2-start-stop-tools repository:...[OK]
Checking property version upgrades:...[OK] -> 1 upgrade(s) found

Upgrading assertj.version property from 2.3.0 to 2.4.0
Checkout of main branch master:...[OK]
Checking existence of the remote branch assertj.version_upgrade_2.3.0_to_2.4.0:...[OK]
Modifying property assertj.version:...[OK]
Create and checkout branch 2.3.0_to_2.4.0:...[OK]
Adding modified pom.xml to commit files:...[OK]
Commiting modified pom.xml files:...[OK]
Pushing the commit to the git repository:...[OK]
Creating the associated GitHub pull-request:...[OK] -> https://github.com/Sylvain-Bugat/aws-ec2-start-stop-tools/pull/52
Deleting clone /cygdrive/c/maven-auto-upgrade-script/aws-ec2-start-stop-tools directory:...[OK]

Troubleshooting

git cannot commit to the cloned repository

This error occurs if no credentials/user settings are permanently used. Try to execute a git push command before executing the script to temporary remember GitHub access or setup a git password cache or use SSH repository URL with a default accepted SSH key.

git cannot clone private repository

Error output example:

Verifying Git version:...[OK] -> git version 2.7.0
Verifying GitHub Hub version:...[OK] found hub command -> hub version 2.2.2
Verifying Maven version:...[OK] -> Apache Maven 3.3.3
Cloning Sylvain-Bugat/private-repo repository:...[FAILED]
Cloning into 'private-repo'...
fatal: could not read Username for 'https://github.com': terminal prompts disabled

Same possible solutions as the previous question.

hub cannot create the pull request on GitHub

Try to execute a hub command like this in a already cloned git repository:

hub ci-status

If it's the first hub execution, user name/password are required to create to register a personal access token on your GitHub account.

Upgrade I refuse/don't want are spammed

At each execution a pull request is created if a new version is found and if an existing branch with the same version upgrade is not already found.

If you don't want an upgrade or you don't want to apply it right now you can keep the associated branch alive as long as you want. But for some strange/incompatible version the dependency version must be completely ignored.

Not release version upgrade are generated

There are some case were pre-release versions are detected even if only release repositories are used:

  • Alpha/beta versions (A)
  • Release canditate versions (RC)
  • Draft versions
  • Milestone versions (M) Because these versions are published on release repositories for public tests.

To ignore some dependencies/plugins versions, the Maven versions plugin configuration can be modified. Example of Such configuration on Rundeck Monitor.

Some upgrade are not detected

This is a limitation of these scripts, they uses mvn versions:display-plugin-updates versions:display-property-updates to find dependency/plugin version upgrades. Dependencies with direct version configuration like this cannot be detected and upgraded:

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-ext</artifactId>
    <version>1.7.19</version>
</dependency>

To fix that, the version must be in a property value like this:

<properties>
    <org.slf4j.version>1.7.19</org.slf4j.version>
</properties>
...
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-ext</artifactId>
    <version>${org.slf4j.version}</version>
</dependency>

My git repository is not on GitHub

These scripts can be used without the hub command, in this case, branch with new dependency/plugin version are commited but no pull-request can be created on GitHub.

Another issue/bug, feature requests or questions?

Issues, bugs, and feature requests should be submitted on GitHub maven-auto-upgrade-script issue tracking.

Thanks to