Class PublishIssuesStep
java.lang.Object
hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
org.jenkinsci.plugins.workflow.steps.Step
io.jenkins.plugins.analysis.core.steps.PublishIssuesStep
- All Implemented Interfaces:
ExtensionPoint
,Describable<org.jenkinsci.plugins.workflow.steps.Step>
,Serializable
public class PublishIssuesStep
extends org.jenkinsci.plugins.workflow.steps.Step
implements Serializable
Publish issues created by a static analysis build. The recorded issues are stored as a
ResultAction
in the
associated Jenkins build. If the issues report has a unique ID, then the created action will use this ID as well.
Otherwise a default ID is used to publish the results. In any case, the computed ID can be overwritten by specifying
an ID as step parameter.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Descriptor for this step: defines the context and the UI labels.Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Constructor Summary
ConstructorsConstructorDescriptionPublishIssuesStep
(List<AnnotatedReport> issues) Creates a new instance ofPublishIssuesStep
. -
Method Summary
Modifier and TypeMethodDescriptionint
Deprecated.int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
boolean
int
getId()
boolean
boolean
edu.hm.hafner.analysis.Severity
getName()
Returns the reference build id of the reference job to get the results for the issue difference computation.Returns the reference job to get the results for the issue difference computation.int
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
boolean
Returns whether all issues should be published using the Checks API.boolean
isQuiet()
boolean
Returns whether publishing checks should be skipped.void
setFailedNewAll
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setFailedNewHigh
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setFailedNewLow
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setFailedNewNormal
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setFailedTotalAll
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setFailedTotalHigh
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setFailedTotalLow
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setFailedTotalNormal
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setFailOnError
(boolean failOnError) Determines whether to fail the build on errors during the step of recording issues.void
setHealthy
(int healthy) Sets the healthy threshold, i.e.void
Defines the ID of the results.void
setIgnoreFailedBuilds
(boolean ignoreFailedBuilds) Iftrue
, then only successful or unstable reference builds will be considered.void
setIgnoreQualityGate
(boolean ignoreQualityGate) Iftrue
, then the result of the quality gate is ignored when selecting a reference build.void
setMinimumSeverity
(String minimumSeverity) Sets the minimum severity to consider when computing the health report.void
Defines the name of the results.void
setPublishAllIssues
(boolean publishAllIssues) void
setQualityGates
(List<QualityGate> qualityGates) Defines the optional list of quality gates.void
setQuiet
(boolean quiet) Iftrue
, then logger content is muted Iffalse
, then logger content goes to loghandler output.void
setReferenceBuildId
(String referenceBuildId) Sets the reference build id of the reference job for the issue difference computation.void
setReferenceJobName
(String referenceJobName) Sets the reference job to get the results for the issue difference computation.void
setSkipPublishingChecks
(boolean skipPublishingChecks) void
setSourceCodeEncoding
(String sourceCodeEncoding) Sets the encoding to use to read source files.void
setTrendChartType
(TrendChartType trendChartType) Sets the type of the trend chart that should be shown on the job page.void
setUnhealthy
(int unhealthy) Sets the healthy threshold, i.e.void
setUnstableNewAll
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setUnstableNewHigh
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setUnstableNewLow
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setUnstableNewNormal
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setUnstableTotalAll
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setUnstableTotalHigh
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setUnstableTotalLow
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
void
setUnstableTotalNormal
(int size) Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
org.jenkinsci.plugins.workflow.steps.StepExecution
start
(org.jenkinsci.plugins.workflow.steps.StepContext stepContext) Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step
getDescriptor
-
Constructor Details
-
PublishIssuesStep
Creates a new instance ofPublishIssuesStep
.- Parameters:
issues
- the reports to publish asAction
in theJob
.- Throws:
IllegalArgumentException
- if the array of issues isnull
or empty
-
-
Method Details
-
getIssues
-
setId
Defines the ID of the results. The ID is used as URL of the results and as name in UI elements. If no ID is given, then the ID of the associated result object is used.- Parameters:
id
- the ID of the results
-
getId
-
setName
Defines the name of the results. The name is used for all labels in the UI. If no name is given, then the name of the associatedStaticAnalysisLabelProvider
is used.- Parameters:
name
- the name of the results
-
getName
-
setFailOnError
@DataBoundSetter public void setFailOnError(boolean failOnError) Determines whether to fail the build on errors during the step of recording issues.- Parameters:
failOnError
- iftrue
then the build will be failed on errors,false
then errors are only reported in the UI
-
getFailOnError
public boolean getFailOnError() -
isSkipPublishingChecks
public boolean isSkipPublishingChecks()Returns whether publishing checks should be skipped.- Returns:
true
if publishing checks should be skipped,false
otherwise
-
setSkipPublishingChecks
@DataBoundSetter public void setSkipPublishingChecks(boolean skipPublishingChecks) -
isPublishAllIssues
public boolean isPublishAllIssues()Returns whether all issues should be published using the Checks API. If set tofalse
only new issues will be published.- Returns:
true
if all issues should be published,false
if only new issues should be published
-
setPublishAllIssues
@DataBoundSetter public void setPublishAllIssues(boolean publishAllIssues) -
setIgnoreQualityGate
@DataBoundSetter public void setIgnoreQualityGate(boolean ignoreQualityGate) Iftrue
, then the result of the quality gate is ignored when selecting a reference build. This option is disabled by default so a failing quality gate will be passed from build to build until the original reason for the failure has been resolved.- Parameters:
ignoreQualityGate
- iftrue
then the result of the quality gate is ignored, otherwise only build with a successful quality gate are selected
-
getIgnoreQualityGate
public boolean getIgnoreQualityGate() -
setIgnoreFailedBuilds
@DataBoundSetter public void setIgnoreFailedBuilds(boolean ignoreFailedBuilds) Iftrue
, then only successful or unstable reference builds will be considered. This option is enabled by default, since analysis results might be inaccurate if the build failed. Iffalse
, every build that contains a static analysis result is considered, even if the build failed.- Parameters:
ignoreFailedBuilds
- iftrue
then a stable build is used as reference
-
getIgnoreFailedBuilds
public boolean getIgnoreFailedBuilds() -
setQuiet
@DataBoundSetter public void setQuiet(boolean quiet) Iftrue
, then logger content is muted Iffalse
, then logger content goes to loghandler output.- Parameters:
quiet
- iftrue
then logger content is muted.
-
isQuiet
public boolean isQuiet() -
setReferenceJobName
Sets the reference job to get the results for the issue difference computation.- Parameters:
referenceJobName
- the name of reference job
-
getReferenceJobName
Returns the reference job to get the results for the issue difference computation. If the job is not defined, thenIssuesRecorder.NO_REFERENCE_DEFINED
is returned.- Returns:
- the name of reference job, or
IssuesRecorder.NO_REFERENCE_DEFINED
if undefined
-
setReferenceBuildId
Sets the reference build id of the reference job for the issue difference computation.- Parameters:
referenceBuildId
- the build id of the reference job
-
getReferenceBuildId
Returns the reference build id of the reference job to get the results for the issue difference computation. If the build id is not defined, thenIssuesRecorder.NO_REFERENCE_DEFINED
is returned.- Returns:
- the reference build id, or
IssuesRecorder.NO_REFERENCE_DEFINED
if undefined
-
getSourceCodeEncoding
-
setSourceCodeEncoding
Sets the encoding to use to read source files.- Parameters:
sourceCodeEncoding
- the encoding, e.g. "ISO-8859-1"
-
getHealthy
public int getHealthy() -
setHealthy
@DataBoundSetter public void setHealthy(int healthy) Sets the healthy threshold, i.e. the number of issues when health is reported as 100%.- Parameters:
healthy
- the number of issues when health is reported as 100%
-
getUnhealthy
public int getUnhealthy() -
setUnhealthy
@DataBoundSetter public void setUnhealthy(int unhealthy) Sets the healthy threshold, i.e. the number of issues when health is reported as 0%.- Parameters:
unhealthy
- the number of issues when health is reported as 0%
-
getMinimumSeverity
-
getMinimumSeverityAsSeverity
@CheckForNull public edu.hm.hafner.analysis.Severity getMinimumSeverityAsSeverity() -
setMinimumSeverity
Sets the minimum severity to consider when computing the health report. Issues with a severity less than this value will be ignored.- Parameters:
minimumSeverity
- the severity to consider
-
setTrendChartType
Sets the type of the trend chart that should be shown on the job page.- Parameters:
trendChartType
- the type of the trend chart to use
-
getTrendChartType
-
setQualityGates
Defines the optional list of quality gates.- Parameters:
qualityGates
- the quality gates
-
getQualityGates
-
setUnstableTotalAll
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableTotalAll
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableTotalHigh
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableTotalHigh
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableNewAll
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableNewAll
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableTotalNormal
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableTotalNormal
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableTotalLow
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableTotalLow
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableNewHigh
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableNewHigh
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableNewNormal
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableNewNormal
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableNewLow
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableNewLow
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedTotalAll
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedTotalAll
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedTotalHigh
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedTotalHigh
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedTotalNormal
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedTotalNormal
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedTotalLow
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedTotalLow
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedNewAll
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedNewAll
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedNewHigh
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedNewHigh
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedNewNormal
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedNewNormal
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedNewLow
Deprecated.replaced byaddQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedNewLow
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
start
public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext stepContext) - Specified by:
start
in classorg.jenkinsci.plugins.workflow.steps.Step
-
getQualityGates()