io.jenkins.plugins.conventionalcommits.utils

Class GoProjectType

java.lang.Object

io.jenkins.plugins.conventionalcommits.utils.GoProjectType

public class GoProjectType
extends Object

Represents a Go project type. Projects with the go.mod file are supported.

Constructor Summary

Constructors

Constructor and Description
GoProjectType()

Method Summary

Modifier and Type	Method and Description
boolean	check(File directory) Checks if the go.mod config file exists at the root 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) Gets the current version of the Go module as indicated by release tag on GitHub.
void	writeVersion(File directory, com.github.zafarkhaja.semver.Version nextVersion, ProcessHelper processHelper) Checks if there is a Go config file (go.mod) file in the directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

GoProjectType

public GoProjectType()

Method Detail

check

public boolean check(File directory)

Checks if the go.mod config file exists at the root directory.

Parameters:

directory - The directory in which the go.mod file is searched for.

Returns:

A boolean true / false is returned.

getCurrentVersion

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

Gets the current version of the Go module as indicated by release tag on GitHub.

Parameters:

directory - The directory in which the go.mod file is ideally found.

processHelper - The helper to run the "go list" command.

Returns:

The current version of the Go module concerned.

Throws:

IOException - If an error is thrown while file is read.

InterruptedException - If an error is thrown due to interruption.

writeVersion

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

Checks if there is a Go config file (go.mod) file in the directory. If that's the case then the file will remain the same. This is because for Go modules the release version is from GitHub repository tags.

Parameters:

directory - The directory to which the file is written.

nextVersion - The next version to use.

processHelper - The helper to run the command (not used here).

Throws:

org.apache.commons.lang.NotImplementedException - If not implemented means the Go project is not supported.

IOException - If an error is thrown while file is read.

InterruptedException - If an error is thrown due to interruption.

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