Class ResolveScmStep

  • All Implemented Interfaces:
    ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>

    public class ResolveScmStep
    extends org.jenkinsci.plugins.workflow.steps.Step
    Resolves an SCM from a SCMSource using a priority list of target branch names.
    Since:
    2.10
    • Constructor Detail

      • ResolveScmStep

        @DataBoundConstructor
        public ResolveScmStep​(@NonNull
                              jenkins.scm.api.SCMSource source,
                              @NonNull
                              List<String> targets)
        Constructor.
        Parameters:
        source - The SCMSource
        targets - The SCMSource
    • Method Detail

      • getSource

        @NonNull
        public jenkins.scm.api.SCMSource getSource()
        Gets the SCMSource to resolve from.
        Returns:
        the SCMSource to resolve from.
      • getTargets

        @NonNull
        public List<String> getTargets()
        Gets the SCMHead names to try and resolve.
        Returns:
        the SCMHead names to try and resolve.
      • isIgnoreErrors

        public boolean isIgnoreErrors()
        Returns true if and only if errors will be ignored.
        Returns:
        true if and only if errors will be ignored.
      • setIgnoreErrors

        @DataBoundSetter
        public void setIgnoreErrors​(boolean ignoreErrors)
        Sets the error handling behaviour.
        Parameters:
        ignoreErrors - true if and only if errors will be ignored.
      • start

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