Package io.jenkins.plugins.github_pr_approval

Class PendingApprovalAction

java.lang.Object

io.jenkins.plugins.github_pr_approval.PendingApprovalAction

All Implemented Interfaces:

Action, ModelObject

public class PendingApprovalAction
extends Object
implements Action

Shown on a branch job while its fork pull request waits for external approval, with the buttons and endpoints an administrator uses to approve or take back that approval.

What holds the pull request back is PendingApprovalAction.ApprovalQueueGuard. The job stays enabled and shows a "pending approval" banner rather than being disabled, so a project administrator can still start a one-off build with "Build Now" while everyone else is refused.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PendingApprovalAction.ActionFactory	Attaches a PendingApprovalAction to any branch job that needs external approval.
static class	PendingApprovalAction.ApprovalItemListener	Puts a newly discovered fork pull request on hold, and catches the jobs that were already there when the trust policy got switched on.
static class	PendingApprovalAction.ApprovalQueueGuard	The gate that stops an unapproved fork pull request from building.
static class	PendingApprovalAction.ApprovalScanListener	Settles every pull request once a branch scan has finished.
static class	PendingApprovalAction.ApprovalSpender	Spends the approval once the build it was granted for has started: the record goes back to pending, so the guard makes the next commit ask for a fresh approval.
static enum	PendingApprovalAction.ApprovalState	Approval state of an external pull request.
static class	PendingApprovalAction.ExternalApprovalCause	Marks a build as having been triggered by an external approval.

Method Summary

Modifier and Type	Method	Description
org.kohsuke.stapler.HttpResponse	doApprove(org.kohsuke.stapler.StaplerRequest2 req)	Approves the pull request: enables the job and starts a build.
org.kohsuke.stapler.HttpResponse	doReject(org.kohsuke.stapler.StaplerRequest2 req)	Takes the approval back; once the record is pending again the guard blocks the pull request.
String	getCurrentPullHash()
String	getDisplayName()
String	getIconFileName()
Job<?,?>	getOwner()
String	getPrAuthor()
int	getPrNumber()
PendingApprovalAction.ApprovalState	getState()
String	getUrlName()
boolean	isRequireApprovalForNewCommits()

Methods inherited from class java.lang.Object

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

Method Details

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getState

public PendingApprovalAction.ApprovalState getState()

getPrNumber

public int getPrNumber()

getPrAuthor

public String getPrAuthor()

getCurrentPullHash

public String getCurrentPullHash()

isRequireApprovalForNewCommits

public boolean isRequireApprovalForNewCommits()

getOwner

public Job<?,?> getOwner()

doApprove

@POST
public org.kohsuke.stapler.HttpResponse doApprove(org.kohsuke.stapler.StaplerRequest2 req)

Approves the pull request: enables the job and starts a build.

doReject

@POST
public org.kohsuke.stapler.HttpResponse doReject(org.kohsuke.stapler.StaplerRequest2 req)

Takes the approval back; once the record is pending again the guard blocks the pull request.