Package com.cloudbees.jenkins

Class GitHubPushTrigger

java.lang.Object

hudson.triggers.Trigger<Job<?,?>>

com.cloudbees.jenkins.GitHubPushTrigger

All Implemented Interfaces:

GitHubTrigger, ExtensionPoint, Describable<Trigger<?>>

public class GitHubPushTrigger
extends Trigger<Job<?,?>>
implements GitHubTrigger

Triggers a build when we receive a GitHub post-commit webhook.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubPushTrigger.DescriptorImpl
final class	GitHubPushTrigger.GitHubWebHookPollingAction	Action object for Project.

Nested classes/interfaces inherited from class hudson.triggers.Trigger

Trigger.Cron

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface com.cloudbees.jenkins.GitHubTrigger

GitHubTrigger.GitHubRepositoryNameContributorImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	ALLOW_HOOKURL_OVERRIDE	Set to false to prevent the user from overriding the hook URL.

Fields inherited from class hudson.triggers.Trigger

CRON_THRESHOLD, job, spec, tabs, timer

Constructor Summary

Constructors

Constructor	Description
GitHubPushTrigger()

Method Summary

Modifier and Type	Method	Description
GitHubPushTrigger.DescriptorImpl	getDescriptor()
Set<GitHubRepositoryName>	getGitHubRepositories()	Deprecated. Use GitHubRepositoryNameContributor.parseAssociatedNames(AbstractProject)
File	getLogFile()	Returns the file that records the last/current polling activity.
Collection<? extends Action>	getProjectActions()
void	onPost()	Deprecated.
void	onPost(GitHubTriggerEvent event)	Called when a POST is made.
void	onPost(String triggeredByUser)	Called when a POST is made.
void	registerHooks()	Tries to register hook for current associated job.
void	start(Job<?,?> project, boolean newInstance)
void	stop()

Methods inherited from class hudson.triggers.Trigger

all, checkTriggers, for_, getProjectAction, getSpec, readResolve, run, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ALLOW_HOOKURL_OVERRIDE

public static final boolean ALLOW_HOOKURL_OVERRIDE

Set to false to prevent the user from overriding the hook URL.

Constructor Details

GitHubPushTrigger

@DataBoundConstructor
public GitHubPushTrigger()

Method Details

onPost

@Deprecated
public void onPost()

Deprecated.

Called when a POST is made.

Specified by:

onPost in interface GitHubTrigger

onPost

public void onPost(String triggeredByUser)

Called when a POST is made.

Specified by:

onPost in interface GitHubTrigger

onPost

public void onPost(GitHubTriggerEvent event)

Called when a POST is made.

getLogFile

public File getLogFile()

Returns the file that records the last/current polling activity.

getGitHubRepositories

@Deprecated
public Set<GitHubRepositoryName> getGitHubRepositories()

Deprecated.

Use GitHubRepositoryNameContributor.parseAssociatedNames(AbstractProject)

Description copied from interface: GitHubTrigger

Obtains the list of the repositories that this trigger is looking at. If the implementation of this class maintain its own list of GitHub repositories, it should continue to implement this method for backward compatibility, and it gets picked up by GitHubRepositoryNameContributor.parseAssociatedNames(AbstractProject).

Alternatively, if the implementation doesn't worry about the backward compatibility, it can implement this method to return an empty collection, then just implement GitHubRepositoryNameContributor.

Specified by:

getGitHubRepositories in interface GitHubTrigger

start

public void start(Job<?,?> project,
 boolean newInstance)

Overrides:

start in class Trigger<Job<?,?>>

registerHooks

public void registerHooks()

Tries to register hook for current associated job. Do this lazily to avoid blocking the UI thread. Useful for using from groovy scripts.

Since:

1.11.2

stop

public void stop()

Overrides:

stop in class Trigger<Job<?,?>>

getProjectActions

public Collection<? extends Action> getProjectActions()

Overrides:

getProjectActions in class Trigger<Job<?,?>>

getDescriptor

public GitHubPushTrigger.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Trigger<?>>

Overrides:

getDescriptor in class Trigger<Job<?,?>>