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

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.

  • Constructor Details

    • ScanForIssuesStep

      @DataBoundConstructor public ScanForIssuesStep()
      Creates a new instance of ScanForIssuesStep.

  • Method Details

    • getTool

      @CheckForNull public Tool getTool()

    • setTool

      @DataBoundSetter public void setTool(Tool tool)
      Sets the static analysis tool that will scan files and create issues.
      Parameters:
      tool - the static analysis tool

    • getFilters

      public List<RegexpFilter> getFilters()

    • setFilters

      @DataBoundSetter public void setFilters(List<RegexpFilter> filters)

    • 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

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

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

      @DataBoundSetter @Deprecated public void setForensicsDisabled(boolean forensicsDisabled)
      Deprecated.
      Forensics will be automatically skipped if the Forensics recorder is not activated.
      Not used anymore.
      Parameters:
      forensicsDisabled - not used

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

    • getSourceDirectory

      public String getSourceDirectory()

    • setSourceDirectory

      @DataBoundSetter public void setSourceDirectory(String sourceDirectory)
      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

      public List<io.jenkins.plugins.prism.SourceCodeDirectory> getSourceDirectories()

    • start

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