Skip to main content

GitHubPushEvent

No description

type GitHubPushEvent {
  ref: String!
  before: String!
  after: String!
  created: Boolean!
  deleted: Boolean!
  forced: Boolean!
  headCommit: GitHubPushEventCommit!
  compare: String!
  commits: [GitHubPushEventCommit!]!
  pusher: GitHubPushEventPusher!
  repository: GitHubPushEventRepository!
}

Fields​

GitHubPushEvent.ref ● String! non-null scalar​

The full git ref that was pushed. Example: refs/heads/main or refs/tags/v3.14.1.

GitHubPushEvent.before ● String! non-null scalar​

The SHA of the most recent commit on ref before the push.

GitHubPushEvent.after ● String! non-null scalar​

The SHA of the most recent commit on ref after the push.

GitHubPushEvent.created ● Boolean! non-null scalar​

Whether this push created the ref.

GitHubPushEvent.deleted ● Boolean! non-null scalar​

Whether this push deleted the ref.

GitHubPushEvent.forced ● Boolean! non-null scalar​

Whether this push was a force push of the ref.

GitHubPushEvent.headCommit ● GitHubPushEventCommit! non-null object​

For pushes where after is or points to a commit object, an expanded representation of that commit. For pushes where after refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag.

GitHubPushEvent.compare ● String! non-null scalar​

URL that shows the changes in this ref update, from the before commit to the after commit. For a newly created ref that is directly based on the default branch, this is the comparison between the head of the default branch and the after commit. Otherwise, this shows all commits until the after commit.

GitHubPushEvent.commits ● [GitHubPushEventCommit!]! non-null object​

An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.)

GitHubPushEvent.pusher ● GitHubPushEventPusher! non-null object​

The user who pushed the commits.

GitHubPushEvent.repository ● GitHubPushEventRepository! non-null object​

The repository where the event occurred.

Implemented by​

GitHubEvent union