Package org.kohsuke.github
Class GHEventPayload.Push
java.lang.Object
org.kohsuke.github.GHEventPayload
org.kohsuke.github.GHEventPayload.Push
- Enclosing class:
- GHEventPayload
A commit was pushed.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Commit in a push.static class
The type Pusher.Nested classes/interfaces inherited from class org.kohsuke.github.GHEventPayload
GHEventPayload.CheckRun, GHEventPayload.CheckSuite, GHEventPayload.CommentChanges, GHEventPayload.CommitComment, GHEventPayload.Create, GHEventPayload.Delete, GHEventPayload.Deployment, GHEventPayload.DeploymentStatus, GHEventPayload.Discussion, GHEventPayload.DiscussionComment, GHEventPayload.Fork, GHEventPayload.Installation, GHEventPayload.InstallationRepositories, GHEventPayload.Issue, GHEventPayload.IssueComment, GHEventPayload.Label, GHEventPayload.Member, GHEventPayload.Membership, GHEventPayload.Ping, GHEventPayload.ProjectsV2Item, GHEventPayload.Public, GHEventPayload.PullRequest, GHEventPayload.PullRequestReview, GHEventPayload.PullRequestReviewComment, GHEventPayload.Push, GHEventPayload.Release, GHEventPayload.Repository, GHEventPayload.Star, GHEventPayload.Status, GHEventPayload.Team, GHEventPayload.TeamAdd, GHEventPayload.WorkflowDispatch, GHEventPayload.WorkflowJob, GHEventPayload.WorkflowRun
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThis is undocumented, but it looks like this captures the commit that the ref was pointing to before the push.The list of pushed commits.Gets compare.getHead()
The SHA of the HEAD commit on the repository.The head commit of the push.Gets pusher.getRef()
The full Git ref that was pushed.getRoot()
Deprecated.int
getSize()
The number of commits in the push.boolean
Is created boolean.boolean
Is deleted boolean.boolean
isForced()
Is forced boolean.void
setPusher
(GHEventPayload.Push.Pusher pusher) Deprecated.Do not use this method.Methods inherited from class org.kohsuke.github.GHEventPayload
getAction, getInstallation, getOrganization, getRepository, getSender, setOrganization, setRepository, setSender
-
Constructor Details
-
Push
public Push()
-
-
Method Details
-
getHead
The SHA of the HEAD commit on the repository.- Returns:
- the head
-
getBefore
This is undocumented, but it looks like this captures the commit that the ref was pointing to before the push.- Returns:
- the before
-
getRef
The full Git ref that was pushed. Example: “refs/heads/main”- Returns:
- the ref
-
getSize
public int getSize()The number of commits in the push. Is this always the same asgetCommits().size()
?- Returns:
- the size
-
isCreated
public boolean isCreated()Is created boolean.- Returns:
- the boolean
-
isDeleted
public boolean isDeleted()Is deleted boolean.- Returns:
- the boolean
-
isForced
public boolean isForced()Is forced boolean.- Returns:
- the boolean
-
getCommits
The list of pushed commits.- Returns:
- the commits
-
getHeadCommit
The head commit of the push.- Returns:
- the commit
-
getPusher
Gets pusher.- Returns:
- the pusher
-
setPusher
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets pusher.- Parameters:
pusher
- the pusher
-
getCompare
Gets compare.- Returns:
- compare
-
getRoot
Deprecated.For access to theGitHub
instance, use a local copy instead of pulling it out of objects.Get the rootGitHub
instance for this object.- Returns:
- the root
GitHub
instance
-
GitHub
instance, use a local copy instead of pulling it out of objects.