Struct PushEvent

pub struct PushEvent {

    pub after: String,
    pub base_ref: Option<String>,
    pub before: String,
    pub commits: Vec<Commit>,
    pub compare: String,
    pub created: bool,
    pub deleted: bool,
    pub forced: bool,
    pub head_commit: Option<Commit>,
    pub installation: Option<InstallationLite>,
    pub organization: Option<Organization>,
    pub pusher: Committer,
    pub ref_: String,
    pub repository: Repository,
    pub sender: User,
}

PushEvent

JSON schema

{
 "title": "push event",
 "type": "object",
 "required": [
   "after",
   "base_ref",
   "before",
   "commits",
   "compare",
   "created",
   "deleted",
   "forced",
   "head_commit",
   "pusher",
   "ref",
   "repository",
   "sender"
 ],
 "properties": {
   "after": {
     "description": "The SHA of the most recent commit on `ref` after the push.",
     "type": "string"
   },
   "base_ref": {
     "type": [
       "string",
       "null"
     ]
   },
   "before": {
     "description": "The SHA of the most recent commit on `ref` before the push.",
     "type": "string"
   },
   "commits": {
     "description": "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.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/en/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.",
     "type": "array",
     "items": {
       "$ref": "#/definitions/commit"
     }
   },
   "compare": {
     "description": "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.",
     "type": "string"
   },
   "created": {
     "description": "Whether this push created the `ref`.",
     "type": "boolean"
   },
   "deleted": {
     "description": "Whether this push deleted the `ref`.",
     "type": "boolean"
   },
   "forced": {
     "description": "Whether this push was a force push of the `ref`.",
     "type": "boolean"
   },
   "head_commit": {
     "description": "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.",
     "oneOf": [
       {
         "$ref": "#/definitions/commit"
       },
       {
         "type": "null"
       }
     ]
   },
   "installation": {
     "$ref": "#/definitions/installation-lite"
   },
   "organization": {
     "$ref": "#/definitions/organization"
   },
   "pusher": {
     "$ref": "#/definitions/committer"
   },
   "ref": {
     "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.",
     "type": "string"
   },
   "repository": {
     "$ref": "#/definitions/repository"
   },
   "sender": {
     "$ref": "#/definitions/user"
   }
 },
 "additionalProperties": false,
 "$schema": "http://json-schema.org/draft-07/schema"
}

Fields

after: String

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

base_ref: Option<String>

before: String

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

commits: Vec<Commit>

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.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn’t applied to webhook deliveries.

compare: String

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.

created: bool

Whether this push created the ref.

deleted: bool

Whether this push deleted the ref.

forced: bool

Whether this push was a force push of the ref.

head_commit: Option<Commit>

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.

installation: Option<InstallationLite>

organization: Option<Organization>

pusher: Committer

ref_: String

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

repository: Repository

sender: User

Implementations

impl PushEvent

pub fn builder() -> PushEvent

Trait Implementations

impl Clone for PushEvent

fn clone(&self) -> PushEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PushEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PushEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PushEvent> for PushEvent

fn from(value: &PushEvent) -> Self

Converts to this type from the input type.

impl From<PushEvent> for PushEvent

fn from(value: PushEvent) -> Self

Converts to this type from the input type.

impl Serialize for PushEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PushEvent> for PushEvent

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: PushEvent) -> Result<Self, String>

Performs the conversion.