io.jenkins.plugins.conventionalcommits.utils

Class GradleProjectType

java.lang.Object

io.jenkins.plugins.conventionalcommits.utils.GradleProjectType

public class GradleProjectType
extends Object

Represent a Gradle project type (i.e with a build.gradle file).

Constructor Summary

Constructors

Constructor and Description
GradleProjectType()

Method Summary

Modifier and Type	Method and Description
boolean	check(File directory)
boolean	createNewUpdateFile(String buildPath, String buildTempPath, com.github.zafarkhaja.semver.Version nextVersion, boolean isIndented, String[] matchingWords) Write an updated temporary file with next version then replace the project config file with it.
com.github.zafarkhaja.semver.Version	getCurrentVersion(File directory, ProcessHelper processHelper)
void	writeVersion(File directory, com.github.zafarkhaja.semver.Version nextVersion, ProcessHelper processHelper) Write the new calculated version in the build.gradle file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GradleProjectType

public GradleProjectType()

Method Detail

check

public boolean check(File directory)

getCurrentVersion

public com.github.zafarkhaja.semver.Version getCurrentVersion(File directory,
                                                              ProcessHelper processHelper)
                                                       throws IOException,
                                                              InterruptedException

Throws:

IOException

InterruptedException

writeVersion

public void writeVersion(File directory,
                         com.github.zafarkhaja.semver.Version nextVersion,
                         ProcessHelper processHelper)
                  throws IOException,
                         InterruptedException

Write the new calculated version in the build.gradle file. If no version property is found, do nothing.

Parameters:

directory - The directory where find the build.gradle. Mandatory

nextVersion - The next version to write. Mandatory

processHelper - Not used.

Throws:

IOException - If an error occurs when accessing to the build.gradle

InterruptedException - Not used.

createNewUpdateFile

public boolean createNewUpdateFile(String buildPath,
                                   String buildTempPath,
                                   com.github.zafarkhaja.semver.Version nextVersion,
                                   boolean isIndented,
                                   String[] matchingWords)
                            throws IOException

Write an updated temporary file with next version then replace the project config file with it.

Parameters:

buildPath - Path of the file updated

buildTempPath - Path of a temporary file to replace buildPath

nextVersion - Version to update config file

isIndented - Can the config file have indentation

matchingWords - Tab of word to match the version

Returns:

if a version tag was found

Throws:

IOException - If errors occurs when write the file