Package io.jenkins.plugins.analysis.core.steps

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:

  • Constructor Details

  • Method Details

    • getIssues

      public List<AnnotatedReport> getIssues()

    • setId

      @DataBoundSetter public void setId(String id)
      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

      public String getId()

    • setName

      @DataBoundSetter public void setName(String name)
      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 associated StaticAnalysisLabelProvider is used.
      Parameters:
      name - the name of the results

    • getName

      public String getName()

    • setIcon

      @DataBoundSetter public void setIcon(String icon)
      Defines the custom icon of the results. If no icon is given, then the default icon of the associated StaticAnalysisLabelProvider is used.
      Parameters:
      icon - the icon of the results

    • getIcon

      public String getIcon()

    • 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()

    • setFailOnError

      @DataBoundSetter public void setFailOnError(boolean failOnError)
      Determines whether to fail the step on errors during the step of recording issues.
      Parameters:
      failOnError - if true then the build will be failed on errors, false then errors are only reported in the UI

    • getFailOnError

      public boolean getFailOnError()

    • isSkipDeltaCalculation

      public boolean isSkipDeltaCalculation()
      Returns whether the SCM delta calculation for the new issue detection should be disabled.
      Returns:
      true if the SCM delta calculation for the new issue detection should be disabled.

    • setSkipDeltaCalculation

      @DataBoundSetter public void setSkipDeltaCalculation(boolean skipDeltaCalculation)

    • 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)

    • setChecksAnnotationScope

      @DataBoundSetter public void setChecksAnnotationScope(io.jenkins.plugins.analysis.core.steps.WarningChecksPublisher.ChecksAnnotationScope checksAnnotationScope)
      Sets the scope of the annotations that should be published to SCM checks.
      Parameters:
      checksAnnotationScope - the scope to use

    • getChecksAnnotationScope

      public io.jenkins.plugins.analysis.core.steps.WarningChecksPublisher.ChecksAnnotationScope getChecksAnnotationScope()

    • isPublishAllIssues

      @Deprecated public boolean isPublishAllIssues()
      Deprecated.
      use getChecksAnnotationScope() instead
      Returns whether all issues should be published using the Checks API. If set to false only new issues will be published.
      Returns:
      true if all issues should be published, false if only new issues should be published

    • setPublishAllIssues

      @Deprecated @DataBoundSetter public void setPublishAllIssues(boolean publishAllIssues)
      Deprecated.
      use setChecksAnnotationScope(ChecksAnnotationScope) instead
      Returns whether all issues should be published to SCM checks.
      Parameters:
      publishAllIssues - if true then all issues should be published, otherwise only new issues

    • setIgnoreQualityGate

      @DataBoundSetter public void setIgnoreQualityGate(boolean ignoreQualityGate)
      If true, 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 - if true then the result of the quality gate is ignored, otherwise only build with a successful quality gate are selected

    • getIgnoreQualityGate

      public boolean getIgnoreQualityGate()

    • setQuiet

      @DataBoundSetter public void setQuiet(boolean quiet)
      If true, then logger content is muted If false, then logger content goes to loghandler output.
      Parameters:
      quiet - if true then logger content is muted.

    • isQuiet

      public boolean isQuiet()

    • getSourceCodeEncoding

      @CheckForNull public String getSourceCodeEncoding()

    • setSourceCodeEncoding

      @DataBoundSetter public void setSourceCodeEncoding(String sourceCodeEncoding)
      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

      @CheckForNull public String getMinimumSeverity()

    • getMinimumSeverityAsSeverity

      @CheckForNull public edu.hm.hafner.analysis.Severity getMinimumSeverityAsSeverity()

    • setMinimumSeverity

      @DataBoundSetter public void setMinimumSeverity(String minimumSeverity)
      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

      @DataBoundSetter public void setTrendChartType(TrendChartType trendChartType)
      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

      public TrendChartType getTrendChartType()

    • setQualityGates

      @DataBoundSetter public void setQualityGates(List<WarningsQualityGate> qualityGates)
      Defines the optional list of quality gates.
      Parameters:
      qualityGates - the quality gates

    • getQualityGates

      public List<WarningsQualityGate> getQualityGates()

    • start

      public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext stepContext)
      Specified by:
      start in class org.jenkinsci.plugins.workflow.steps.Step