Package io.jenkins.plugins.forensics.miner

Class RepositoryMinerStep

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

io.jenkins.plugins.forensics.miner.RepositoryMinerStep

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class RepositoryMinerStep
extends Recorder
implements SimpleBuildStep

A pipeline Step or Freestyle or Maven Recorder that obtains statistics for all repository files. The following statistics are computed:

• total number of commits
• total number of different authors
• creation time
• last modification time
• lines of code (from the commit details)
• code churn (changed lines since created)

Stores the created statistics in a RepositoryStatistics instance. The result is attached to a Run by registering a ForensicsBuildAction.

Author:

Ullrich Hafner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RepositoryMinerStep.Descriptor	Descriptor for this step: defines the context and the UI elements.

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

Publisher.DescriptorExtensionListImpl

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
RepositoryMinerStep()	Creates a new instance of RepositoryMinerStep.

Method Summary

Modifier and Type	Method	Description
RepositoryMinerStep.Descriptor	getDescriptor()
String	getScm()
void	perform(Run<?,?> run, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener)
protected Object	readResolve()	Called after deserialization to retain backward compatibility or to populate new elements (that would be otherwise initialized to null).
void	setScm(String scm)	Sets the SCM that should be used to find the reference build for.

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, getRequiredMonitorService, perform, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

RepositoryMinerStep

@DataBoundConstructor
public RepositoryMinerStep()

Creates a new instance of RepositoryMinerStep.

Method Details

readResolve

protected Object readResolve()

Called after deserialization to retain backward compatibility or to populate new elements (that would be otherwise initialized to null).

Returns:

this

setScm

@DataBoundSetter
public void setScm(String scm)

Sets the SCM that should be used to find the reference build for. The reference recorder will select the SCM based on a substring comparison, there is no need to specify the full name.

Parameters:

scm - the ID of the SCM to use (a substring of the full ID)

getScm

public String getScm()

perform

public void perform(@NonNull
 Run<?,?> run,
 @NonNull
 FilePath workspace,
 @NonNull
 EnvVars env,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
             throws InterruptedException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

getDescriptor

public RepositoryMinerStep.Descriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Recorder