Package hudson.triggers

Class SCMTrigger

java.lang.Object
hudson.triggers.Trigger<Item>
hudson.triggers.SCMTrigger
All Implemented Interfaces:
ExtensionPoint, Describable<Trigger<?>>
public class SCMTrigger extends Trigger<Item>
Trigger that checks for SCM updates periodically. You can add UI elements under the SCM section by creating a config.jelly or config.groovy in the resources area for your class that inherits from SCMTrigger and has the Extension annotation. The UI should be wrapped in an f:section element to denote it.
Author:
Kohsuke Kawaguchi

  • Field Details

    • STARVATION_THRESHOLD

      public static long STARVATION_THRESHOLD
      How long is too long for a polling activity to be in the queue?

  • Constructor Details

    • SCMTrigger

      @DataBoundConstructor public SCMTrigger(String scmpoll_spec)

    • SCMTrigger

      @Deprecated public SCMTrigger(String scmpoll_spec, boolean ignorePostCommitHooks)
      Deprecated.
      since 2.21
      Backwards-compatibility constructor.
      Parameters:
      scmpoll_spec - The spec to poll with.
      ignorePostCommitHooks - Whether to ignore post commit hooks.

  • Method Details

    • isIgnorePostCommitHooks

      public boolean isIgnorePostCommitHooks()
      This trigger wants to ignore post-commit hooks.

      SCM plugins must respect this and not run this trigger for post-commit notifications.

      Since:
      1.493

    • setIgnorePostCommitHooks

      @DataBoundSetter public void setIgnorePostCommitHooks(boolean ignorePostCommitHooks)
      Data-bound setter for ignoring post commit hooks.
      Parameters:
      ignorePostCommitHooks - True if we should ignore post commit hooks, false otherwise.
      Since:
      2.22

    • getScmpoll_spec

      public String getScmpoll_spec()

    • run

      public void run()
      Description copied from class: Trigger
      Executes the triggered task. This method is invoked when Trigger(String) is used to create an instance, and the crontab matches the current time.

      Maybe run even before Trigger.start(hudson.model.Item, boolean), prepare for it.

      Overrides:
      run in class Trigger<Item>

    • run

      public void run(Action[] additionalActions)
      Run the SCM trigger with additional build actions. Used by SubversionRepositoryStatus to trigger a build at a specific revision number.
      Since:
      1.375

    • getDescriptor

      public SCMTrigger.DescriptorImpl getDescriptor()
      Description copied from interface: Describable
      Gets the descriptor for this instance.

      Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

      By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

      Specified by:
      getDescriptor in interface Describable<Trigger<?>>
      Overrides:
      getDescriptor in class Trigger<Item>

    • getProjectActions

      public Collection<? extends Action> getProjectActions()
      Description copied from class: Trigger
      Actions to be displayed in the job page.
      Overrides:
      getProjectActions in class Trigger<Item>
      Returns:
      can be empty but never null

    • getLogFile

      public File getLogFile()
      Returns the file that records the last/current polling activity.