io.jenkins.plugins.conventionalcommits.utils

Class HelmProjectType

java.lang.Object

io.jenkins.plugins.conventionalcommits.utils.HelmProjectType

public class HelmProjectType
extends Object

Represent an Helm project type (i.e with a Chart.yaml file).

Constructor Summary

Constructors

Constructor and Description
HelmProjectType() Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	check(File directory) To know if the project is an Helm project type.
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) Return the next version of the version attribute.
void	writeVersion(File directory, com.github.zafarkhaja.semver.Version nextVersion, ProcessHelper processHelper) Write back to the Chart.yaml the new Version.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelmProjectType

public HelmProjectType()

Default constructor. Init the YAML mapper.

Method Detail

check

public boolean check(File directory)

To know if the project is an Helm project type.

Parameters:

directory - The directory to check. Mandatory

Returns:

true if a Chart.yaml file is found.

getCurrentVersion

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

Return the next version of the version attribute.

Parameters:

directory - The project's directory.

processHelper - Not used.

Returns:

The next calculated version (based on Semver).

Throws:

IOException - If an error occur reading files.

writeVersion

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

Write back to the Chart.yaml the new Version.

Parameters:

directory - The directory where is the Chart.yaml. Mandatory

nextVersion - The next version to write. Mandatory

processHelper - Can be null, not used.

Throws:

IOException - If an error occurred when accessing files or directory.

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