Class ScanForIssuesStep
java.lang.Object
hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
org.jenkinsci.plugins.workflow.steps.Step
io.jenkins.plugins.analysis.core.steps.ScanForIssuesStep
- All Implemented Interfaces:
ExtensionPoint
,Describable<org.jenkinsci.plugins.workflow.steps.Step>
public class ScanForIssuesStep
extends org.jenkinsci.plugins.workflow.steps.Step
Scan files or the console log for issues.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Descriptor for this step: defines the context and the UI elements.Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether SCM blaming should be disabled.boolean
Deprecated.Forensics will be automatically skipped if the Forensics recorder is not activated.getScm()
List<io.jenkins.plugins.prism.SourceCodeDirectory>
getTool()
boolean
isQuiet()
void
setBlameDisabled
(boolean blameDisabled) void
setFilters
(List<RegexpFilter> filters) void
setForensicsDisabled
(boolean forensicsDisabled) Deprecated.Forensics will be automatically skipped if the Forensics recorder is not activated.void
setQuiet
(boolean quiet) Sets whether logging output should be enabled.void
Sets the SCM that should be used to find the reference build for.void
setSourceCodeEncoding
(String sourceCodeEncoding) Sets the encoding to use to read source files.void
setSourceDirectories
(List<io.jenkins.plugins.prism.SourceCodeDirectory> sourceDirectories) Sets the paths to the directories that contain the source code.void
setSourceDirectory
(String sourceDirectory) Sets the path to the folder that contains the source code.void
Sets the static analysis tool that will scan files and create issues.org.jenkinsci.plugins.workflow.steps.StepExecution
start
(org.jenkinsci.plugins.workflow.steps.StepContext context) Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step
getDescriptor
-
Constructor Details
-
ScanForIssuesStep
@DataBoundConstructor public ScanForIssuesStep()Creates a new instance ofScanForIssuesStep
.
-
-
Method Details
-
getTool
-
setTool
Sets the static analysis tool that will scan files and create issues.- Parameters:
tool
- the static analysis tool
-
getFilters
-
setFilters
-
setQuiet
@DataBoundSetter public void setQuiet(boolean quiet) Sets whether logging output should be enabled.- Parameters:
quiet
- boolean flag to mute logging
-
isQuiet
public boolean isQuiet() -
setScm
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
-
getBlameDisabled
public boolean getBlameDisabled()Returns whether SCM blaming should be disabled.- Returns:
true
if SCM blaming should be disabled
-
setBlameDisabled
@DataBoundSetter public void setBlameDisabled(boolean blameDisabled) -
getForensicsDisabled
Deprecated.Forensics will be automatically skipped if the Forensics recorder is not activated.Not used anymore.- Returns:
true
if SCM forensics should be disabled
-
setForensicsDisabled
Deprecated.Forensics will be automatically skipped if the Forensics recorder is not activated.Not used anymore.- Parameters:
forensicsDisabled
- not used
-
getSourceCodeEncoding
-
setSourceCodeEncoding
Sets the encoding to use to read source files.- Parameters:
sourceCodeEncoding
- the encoding, e.g. "ISO-8859-1"
-
getSourceDirectory
-
setSourceDirectory
Sets the path to the folder that contains the source code. If not relative and thus not part of the workspace then this folder needs to be added in Jenkins global configuration.- Parameters:
sourceDirectory
- a folder containing the source code
-
setSourceDirectories
@DataBoundSetter public void setSourceDirectories(List<io.jenkins.plugins.prism.SourceCodeDirectory> sourceDirectories) Sets the paths to the directories that contain the source code. If not relative and thus not part of the workspace then these directories need to be added in Jenkins global configuration to prevent accessing of forbidden resources.- Parameters:
sourceDirectories
- directories containing the source code
-
getSourceDirectories
-
start
public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context) - Specified by:
start
in classorg.jenkinsci.plugins.workflow.steps.Step
-