Skip navigation links
C D E G H I L M N P R S T W 

C

check(File) - Method in class io.jenkins.plugins.conventionalcommits.utils.GoProjectType
Checks if the go.mod config file exists at the root directory.
check(File) - Method in class io.jenkins.plugins.conventionalcommits.utils.GradleProjectType
 
check(File) - Method in class io.jenkins.plugins.conventionalcommits.utils.HelmProjectType
To know if the project is an Helm project type.
check(File) - Method in class io.jenkins.plugins.conventionalcommits.utils.MakeProjectType
 
check(File) - Method in class io.jenkins.plugins.conventionalcommits.utils.MavenProjectType
 
check(File) - Method in class io.jenkins.plugins.conventionalcommits.utils.NpmProjectType
Check if the project is a NPM project (i.e a package.json is found).
check(File) - Method in class io.jenkins.plugins.conventionalcommits.utils.PhpProjectType
Checks if the composer.json config file exists at the root directory.
check(File) - Method in class io.jenkins.plugins.conventionalcommits.utils.PythonProjectType
 
ConventionalCommits - Class in io.jenkins.plugins.conventionalcommits
Class to process conventional commit messages to get next version.
ConventionalCommits() - Constructor for class io.jenkins.plugins.conventionalcommits.ConventionalCommits
 
CurrentVersion - Class in io.jenkins.plugins.conventionalcommits.utils
This class focus on getting the current version (latest release version) of a project.
CurrentVersion() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.CurrentVersion
 
CurrentVersionStep - Class in io.jenkins.plugins.conventionalcommits
Step to get the current version of the project.
CurrentVersionStep() - Constructor for class io.jenkins.plugins.conventionalcommits.CurrentVersionStep
 
CurrentVersionStep.DescriptorImpl - Class in io.jenkins.plugins.conventionalcommits
This Class implements the abstract class StepDescriptor.
CurrentVersionStep.Execution - Class in io.jenkins.plugins.conventionalcommits
This class extends Step Execution class, contains the run method.

D

DefaultProcessHelper - Class in io.jenkins.plugins.conventionalcommits.process
This class runs a given command using ProcessBuilder.
DefaultProcessHelper() - Constructor for class io.jenkins.plugins.conventionalcommits.process.DefaultProcessHelper
 
DescriptorImpl() - Constructor for class io.jenkins.plugins.conventionalcommits.CurrentVersionStep.DescriptorImpl
 
DescriptorImpl() - Constructor for class io.jenkins.plugins.conventionalcommits.NextVersionStep.DescriptorImpl
 

E

equals(Object) - Method in class io.jenkins.plugins.conventionalcommits.dto.HelmChart
 
execute(File, String...) - Static method in class io.jenkins.plugins.conventionalcommits.process.ProcessUtil
Execute a CLI command using ProcessBuilder.
Execution(StepContext) - Constructor for class io.jenkins.plugins.conventionalcommits.CurrentVersionStep.Execution
Constructor with fields initialisation.
Execution(String, String, String, boolean, String, boolean, boolean, boolean, StepContext) - Constructor for class io.jenkins.plugins.conventionalcommits.NextVersionStep.Execution
Constructor with fields initialisation.

G

getBuildMetadata() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
getCurrentVersion(File, String, PrintStream) - Method in class io.jenkins.plugins.conventionalcommits.utils.CurrentVersion
Return the next version of the version attribute.
getCurrentVersion(File, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.GoProjectType
Gets the current version of the Go module as indicated by release tag on GitHub.
getCurrentVersion(File, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.GradleProjectType
 
getCurrentVersion(File, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.HelmProjectType
Return the next version of the version attribute.
getCurrentVersion(File, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.MakeProjectType
 
getCurrentVersion(File, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.MavenProjectType
 
getCurrentVersion(File, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.NpmProjectType
Return the next version of the version attribute.
getCurrentVersion(File, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.PhpProjectType
Gets the current version of the composer.json file if explicitly defined.
getCurrentVersion(File, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.PythonProjectType
 
getDisplayName() - Method in class io.jenkins.plugins.conventionalcommits.CurrentVersionStep.DescriptorImpl
 
getDisplayName() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep.DescriptorImpl
 
getFunctionName() - Method in class io.jenkins.plugins.conventionalcommits.CurrentVersionStep.DescriptorImpl
 
getFunctionName() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep.DescriptorImpl
 
getLatestTag(StepContext, File, boolean) - Static method in class io.jenkins.plugins.conventionalcommits.utils.TagsHelper
Return the last tag.
getOutputFormat() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
getPreRelease() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
getProjectType(File) - Static method in class io.jenkins.plugins.conventionalcommits.utils.ProjectTypeFactory
Detects & returns the type of the project.
getRequiredContext() - Method in class io.jenkins.plugins.conventionalcommits.CurrentVersionStep.DescriptorImpl
 
getRequiredContext() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep.DescriptorImpl
 
getStartTag() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
getVersion() - Method in class io.jenkins.plugins.conventionalcommits.dto.HelmChart
 
getVersion(String) - Method in class io.jenkins.plugins.conventionalcommits.dto.PyProjectToml
Return the next version of the version attribute.
GoProjectType - Class in io.jenkins.plugins.conventionalcommits.utils
Represents a Go project type.
GoProjectType() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.GoProjectType
 
GradleProjectType - Class in io.jenkins.plugins.conventionalcommits.utils
Represent a Gradle project type (i.e with a build.gradle file).
GradleProjectType() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.GradleProjectType
 

H

hashCode() - Method in class io.jenkins.plugins.conventionalcommits.dto.HelmChart
 
HelmChart - Class in io.jenkins.plugins.conventionalcommits.dto
DTO to represent an helm chart's file.
HelmChart() - Constructor for class io.jenkins.plugins.conventionalcommits.dto.HelmChart
 
HelmProjectType - Class in io.jenkins.plugins.conventionalcommits.utils
Represent an Helm project type (i.e with a Chart.yaml file).
HelmProjectType() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.HelmProjectType
Default constructor.

I

io.jenkins.plugins.conventionalcommits - package io.jenkins.plugins.conventionalcommits
 
io.jenkins.plugins.conventionalcommits.dto - package io.jenkins.plugins.conventionalcommits.dto
 
io.jenkins.plugins.conventionalcommits.process - package io.jenkins.plugins.conventionalcommits.process
 
io.jenkins.plugins.conventionalcommits.utils - package io.jenkins.plugins.conventionalcommits.utils
 
isIncrementPreRelease() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
isNonAnnotatedTag() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
isPreservePreRelease() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
isWriteVersion() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 

L

log(Level, Level, Level, Level, boolean, String) - Method in class io.jenkins.plugins.conventionalcommits.utils.LogUtils
Logs to console.
LogUtils - Class in io.jenkins.plugins.conventionalcommits.utils
Handles Logging.
LogUtils() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.LogUtils
 

M

MakeProjectType - Class in io.jenkins.plugins.conventionalcommits.utils
Represent a Make project type (i.e with a Makefile).
MakeProjectType() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.MakeProjectType
 
MavenProjectType - Class in io.jenkins.plugins.conventionalcommits.utils
Represent a Maven project type (i.e with a pom.xml file).
MavenProjectType() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.MavenProjectType
 

N

nextVersion(Version, List<String>) - Method in class io.jenkins.plugins.conventionalcommits.ConventionalCommits
Return the next semantic version.
NextVersionStep - Class in io.jenkins.plugins.conventionalcommits
Base class of the plugin.
NextVersionStep() - Constructor for class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
NextVersionStep.DescriptorImpl - Class in io.jenkins.plugins.conventionalcommits
This Class implements the abstract class StepDescriptor.
NextVersionStep.Execution - Class in io.jenkins.plugins.conventionalcommits
This class extends Step Execution class, contains the run method.
NpmProjectType - Class in io.jenkins.plugins.conventionalcommits.utils
Class to interact with a NPM project type.
NpmProjectType() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.NpmProjectType
 

P

PhpProjectType - Class in io.jenkins.plugins.conventionalcommits.utils
Represents a PHP project type.
PhpProjectType() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.PhpProjectType
 
ProcessHelper - Interface in io.jenkins.plugins.conventionalcommits.process
Interface intended to run CLI commands using ProcessBuilder.
ProcessUtil - Class in io.jenkins.plugins.conventionalcommits.process
Class to execute some CLI commands.
ProcessUtil() - Constructor for class io.jenkins.plugins.conventionalcommits.process.ProcessUtil
 
ProjectTypeFactory - Class in io.jenkins.plugins.conventionalcommits.utils
Factory class to support multiple project types.
ProjectTypeFactory() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.ProjectTypeFactory
 
PyProjectToml - Class in io.jenkins.plugins.conventionalcommits.dto
DTO to represent a pyproject.toml file.
PyProjectToml() - Constructor for class io.jenkins.plugins.conventionalcommits.dto.PyProjectToml
 
PythonProjectType - Class in io.jenkins.plugins.conventionalcommits.utils
Represent a python project type.
PythonProjectType() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.PythonProjectType
 

R

run() - Method in class io.jenkins.plugins.conventionalcommits.CurrentVersionStep.Execution
Entry point of the step.
run() - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep.Execution
 
runProcessBuilder(File, List<String>) - Method in class io.jenkins.plugins.conventionalcommits.process.DefaultProcessHelper
 
runProcessBuilder(File, List<String>) - Method in interface io.jenkins.plugins.conventionalcommits.process.ProcessHelper
 

S

setBuildMetadata(String) - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
setIncrementPreRelease(boolean) - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
setNonAnnotatedTag(boolean) - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
setOutputFormat(String) - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
setPreRelease(String) - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
setPreservePreRelease(boolean) - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
setProcessHelper(ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.CurrentVersion
 
setProcessHelper(ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.WriteVersion
 
setStartTag(String) - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
setVersion(String) - Method in class io.jenkins.plugins.conventionalcommits.dto.HelmChart
 
setWriteVersion(boolean) - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 
start(StepContext) - Method in class io.jenkins.plugins.conventionalcommits.CurrentVersionStep
 
start(StepContext) - Method in class io.jenkins.plugins.conventionalcommits.NextVersionStep
 

T

TagsHelper - Class in io.jenkins.plugins.conventionalcommits.utils
Helper to handle tags.
TagsHelper() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.TagsHelper
 

W

write(Version, File) - Method in class io.jenkins.plugins.conventionalcommits.utils.WriteVersion
Writes next semantic version in a file.
writeVersion(File, Version, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.GoProjectType
Checks if there is a Go config file (go.mod) file in the directory.
writeVersion(File, Version, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.GradleProjectType
Write the new calculated version in the build.gradle file.
writeVersion(File, Version, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.HelmProjectType
Write back to the Chart.yaml the new Version.
writeVersion(File, Version, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.MakeProjectType
 
writeVersion(File, Version, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.MavenProjectType
 
writeVersion(File, Version, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.NpmProjectType
Write back to the package.json file the next version.
Use the npm command version, see : https://docs.npmjs.com/cli/v6/commands/npm-version.
writeVersion(File, Version, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.PhpProjectType
Checks if there is a composer.json file in the directory.
writeVersion(File, Version, ProcessHelper) - Method in class io.jenkins.plugins.conventionalcommits.utils.PythonProjectType
Check if there is a Python config file in the directory (setup.py, setup.cfg, pyproject.toml) If it's the case, change the file with next version wanted.
WriteVersion - Class in io.jenkins.plugins.conventionalcommits.utils
Class to write back the calculated next semantic version into the config file of a project.
WriteVersion() - Constructor for class io.jenkins.plugins.conventionalcommits.utils.WriteVersion
 
C D E G H I L M N P R S T W 
Skip navigation links

Copyright © 2016–2022. All rights reserved.