Class 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 Detail

      • ScanForIssuesStep

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

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

        @DataBoundSetter
        public void setFilters​(List<RegexpFilter> filters)
      • 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
      • 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