io.jenkins.plugins.forensics.git.reference

Class GitReferenceRecorder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

io.jenkins.plugins.forensics.reference.SimpleReferenceRecorder

io.jenkins.plugins.forensics.reference.ReferenceRecorder

io.jenkins.plugins.forensics.git.reference.GitReferenceRecorder

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

@Extension(ordinal=10000.0)
public class GitReferenceRecorder
extends io.jenkins.plugins.forensics.reference.ReferenceRecorder

Recorder that finds a reference build that matches best with the current build of a given Git branch.

Author:

Arne Schöntag, Ullrich Hafner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitReferenceRecorder.Descriptor Descriptor for this step: defines the symbol for the pipeline.

Nested classes/interfaces inherited from class io.jenkins.plugins.forensics.reference.SimpleReferenceRecorder

io.jenkins.plugins.forensics.reference.SimpleReferenceRecorder.SimpleReferenceRecorderDescriptor

Nested classes/interfaces inherited from class hudson.tasks.Publisher

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class io.jenkins.plugins.forensics.reference.SimpleReferenceRecorder

NO_REFERENCE_JOB

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
GitReferenceRecorder() Creates a new instance of GitReferenceRecorder.

Method Summary

Modifier and Type	Method and Description
protected Optional<Run<?,?>>	find(Run<?,?> owner, Run<?,?> lastCompletedBuildOfReferenceJob)
GitReferenceRecorder.Descriptor	getDescriptor()
int	getMaxCommits()
boolean	isSkipUnknownCommits()
void	setMaxCommits(int maxCommits) Sets the maximal number of commits that will be compared with the builds of the reference job to find the matching reference build.
void	setSkipUnknownCommits(boolean skipUnknownCommits) If enabled, then a build of the reference job will be skipped if one of the commits is unknown in the current branch.

Methods inherited from class io.jenkins.plugins.forensics.reference.ReferenceRecorder

findReferenceBuild, getDefaultBranch, isLatestBuildIfNotFound, setDefaultBranch, setLatestBuildIfNotFound

Methods inherited from class io.jenkins.plugins.forensics.reference.SimpleReferenceRecorder

createEmptyReferenceBuild, findJob, getReferenceJob, getRequiredMonitorService, perform, resolveReferenceJob, setReferenceJob

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Constructor Detail

GitReferenceRecorder

@DataBoundConstructor
public GitReferenceRecorder()

Creates a new instance of GitReferenceRecorder.

Method Detail

setMaxCommits

@DataBoundSetter
public void setMaxCommits(int maxCommits)

Sets the maximal number of commits that will be compared with the builds of the reference job to find the matching reference build.

Parameters:

maxCommits - maximal number of commits

getMaxCommits

public int getMaxCommits()

setSkipUnknownCommits

@DataBoundSetter
public void setSkipUnknownCommits(boolean skipUnknownCommits)

If enabled, then a build of the reference job will be skipped if one of the commits is unknown in the current branch.

Parameters:

skipUnknownCommits - if true then builds with unknown commits will be skipped, otherwise unknown commits will be ignored

isSkipUnknownCommits

public boolean isSkipUnknownCommits()

find

protected Optional<Run<?,?>> find(Run<?,?> owner,
                                  Run<?,?> lastCompletedBuildOfReferenceJob)

Specified by:

find in class io.jenkins.plugins.forensics.reference.ReferenceRecorder

getDescriptor

public GitReferenceRecorder.Descriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class io.jenkins.plugins.forensics.reference.SimpleReferenceRecorder