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

    • setFailOnError

      @DataBoundSetter public void setFailOnError(boolean failOnError)
      Determines whether to fail the build 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()

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

      @DataBoundSetter public void setPublishAllIssues(boolean publishAllIssues)

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

    • setIgnoreFailedBuilds

      @DataBoundSetter public void setIgnoreFailedBuilds(boolean ignoreFailedBuilds)
      If true, 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. If false, every build that contains a static analysis result is considered, even if the build failed.
      Parameters:
      ignoreFailedBuilds - if true then a stable build is used as reference

    • getIgnoreFailedBuilds

      public boolean getIgnoreFailedBuilds()

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

    • setReferenceJobName

      @DataBoundSetter public void setReferenceJobName(String referenceJobName)
      Sets the reference job to get the results for the issue difference computation.
      Parameters:
      referenceJobName - the name of reference job

    • getReferenceJobName

      public String getReferenceJobName()
      Returns the reference job to get the results for the issue difference computation. If the job is not defined, then IssuesRecorder.NO_REFERENCE_DEFINED is returned.
      Returns:
      the name of reference job, or IssuesRecorder.NO_REFERENCE_DEFINED if undefined

    • setReferenceBuildId

      @DataBoundSetter public void setReferenceBuildId(String referenceBuildId)
      Sets the reference build id of the reference job for the issue difference computation.
      Parameters:
      referenceBuildId - the build id of the reference job

    • getReferenceBuildId

      public String 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, then IssuesRecorder.NO_REFERENCE_DEFINED is returned.
      Returns:
      the reference build id, or IssuesRecorder.NO_REFERENCE_DEFINED if undefined

    • 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<QualityGate> qualityGates)
      Defines the optional list of quality gates.
      Parameters:
      qualityGates - the quality gates

    • getQualityGates

      public List<QualityGate> getQualityGates()

    • setUnstableTotalAll

      @Deprecated @DataBoundSetter public void setUnstableTotalAll(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getUnstableTotalAll

      @Deprecated public int getUnstableTotalAll()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setUnstableTotalHigh

      @Deprecated @DataBoundSetter public void setUnstableTotalHigh(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getUnstableTotalHigh

      @Deprecated public int getUnstableTotalHigh()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setUnstableNewAll

      @Deprecated @DataBoundSetter public void setUnstableNewAll(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getUnstableNewAll

      @Deprecated public int getUnstableNewAll()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setUnstableTotalNormal

      @Deprecated @DataBoundSetter public void setUnstableTotalNormal(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getUnstableTotalNormal

      @Deprecated public int getUnstableTotalNormal()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setUnstableTotalLow

      @Deprecated @DataBoundSetter public void setUnstableTotalLow(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getUnstableTotalLow

      @Deprecated public int getUnstableTotalLow()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setUnstableNewHigh

      @Deprecated @DataBoundSetter public void setUnstableNewHigh(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getUnstableNewHigh

      @Deprecated public int getUnstableNewHigh()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setUnstableNewNormal

      @Deprecated @DataBoundSetter public void setUnstableNewNormal(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getUnstableNewNormal

      @Deprecated public int getUnstableNewNormal()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setUnstableNewLow

      @Deprecated @DataBoundSetter public void setUnstableNewLow(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getUnstableNewLow

      @Deprecated public int getUnstableNewLow()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setFailedTotalAll

      @Deprecated @DataBoundSetter public void setFailedTotalAll(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getFailedTotalAll

      @Deprecated public int getFailedTotalAll()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setFailedTotalHigh

      @Deprecated @DataBoundSetter public void setFailedTotalHigh(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getFailedTotalHigh

      @Deprecated public int getFailedTotalHigh()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setFailedTotalNormal

      @Deprecated @DataBoundSetter public void setFailedTotalNormal(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getFailedTotalNormal

      @Deprecated public int getFailedTotalNormal()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setFailedTotalLow

      @Deprecated @DataBoundSetter public void setFailedTotalLow(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getFailedTotalLow

      @Deprecated public int getFailedTotalLow()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setFailedNewAll

      @Deprecated @DataBoundSetter public void setFailedNewAll(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getFailedNewAll

      @Deprecated public int getFailedNewAll()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setFailedNewHigh

      @Deprecated @DataBoundSetter public void setFailedNewHigh(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getFailedNewHigh

      @Deprecated public int getFailedNewHigh()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setFailedNewNormal

      @Deprecated @DataBoundSetter public void setFailedNewNormal(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getFailedNewNormal

      @Deprecated public int getFailedNewNormal()
      Deprecated.
      replaced by getQualityGates()
      Gets the quality gate.
      Returns:
      0

    • setFailedNewLow

      @Deprecated @DataBoundSetter public void setFailedNewLow(int size)
      Deprecated.
      replaced by addQualityGate(int, QualityGate.QualityGateType, QualityGate.QualityGateResult)
      Sets the quality gate.
      Parameters:
      size - number of issues

    • getFailedNewLow

      @Deprecated public int getFailedNewLow()
      Deprecated.
      replaced by getQualityGates()
      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 class org.jenkinsci.plugins.workflow.steps.Step