Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions github/event_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -1468,24 +1468,48 @@ type RegistryPackageEvent struct {
}

// ReleaseEvent is triggered when a release is published, unpublished, created,
// edited, deleted, or prereleased.
// edited, deleted, prereleased, or released.
// The Webhook event name is "release".
//
// GitHub API docs: https://docs.github.com/developers/webhooks-and-events/webhook-events-and-payloads#release
type ReleaseEvent struct {
// Action is the action that was performed. Possible values are: "published", "unpublished",
// "created", "edited", "deleted", or "prereleased".
// "created", "edited", "deleted", "prereleased", or "released".
Action *string `json:"action,omitempty"`
Release *RepositoryRelease `json:"release,omitempty"`

// The following fields are only populated by Webhook events.
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
// Changes is populated in "edited" event deliveries.
Changes *ReleaseChanges `json:"changes,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`

// The following field is only present when the webhook is triggered on
// a repository belonging to an organization.
Org *Organization `json:"organization,omitempty"`

// The following field is only present when the webhook is triggered on
// a repository belonging to an enterprise.
Enterprise *Enterprise `json:"enterprise,omitempty"`
}

// ReleaseChanges represents changes made to a release.
type ReleaseChanges struct {
Body *ReleaseChangeFrom `json:"body,omitempty"`
Name *ReleaseChangeFrom `json:"name,omitempty"`
TagName *ReleaseChangeFrom `json:"tag_name,omitempty"`
MakeLatest *ReleaseChangeToBool `json:"make_latest,omitempty"`
}

// ReleaseChangeFrom represents a release string field change containing the previous value.
type ReleaseChangeFrom struct {
From string `json:"from"`
}

// ReleaseChangeToBool represents a boolean release field change containing the new value.
type ReleaseChangeToBool struct {
To bool `json:"to"`
}

// RepositoryEvent is triggered when a repository is created, archived, unarchived,
Expand Down
64 changes: 64 additions & 0 deletions github/github-accessors.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

64 changes: 64 additions & 0 deletions github/github-accessors_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

65 changes: 65 additions & 0 deletions github/messages_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -664,3 +664,68 @@ func TestWebHookType(t *testing.T) {
t.Errorf("WebHookType = %q, want %q", got, want)
}
}

func TestParseWebHook_ReleaseEvent_Edited(t *testing.T) {
t.Parallel()
rawJSON := []byte(`{
"action": "edited",
"changes": {
"body": {
"from": "Old body"
},
"name": {
"from": "Old name"
},
"tag_name": {
"from": "v1.0.0-rc1"
},
"make_latest": {
"to": true
}
},
"release": {
"id": 12345,
"tag_name": "v1.0.0",
"name": "Release 1.0.0",
"body": "New body"
},
"enterprise": {
"id": 1,
"slug": "octocat-enterprise"
}
}`)

got, err := ParseWebHook("release", rawJSON)
if err != nil {
t.Fatalf("ParseWebHook failed: %v", err)
}

event, ok := got.(*ReleaseEvent)
if !ok {
t.Fatalf("ParseWebHook returned %v, want *ReleaseEvent", got)
}

want := &ReleaseEvent{
Action: new("edited"),
Changes: &ReleaseChanges{
Body: &ReleaseChangeFrom{From: "Old body"},
Name: &ReleaseChangeFrom{From: "Old name"},
TagName: &ReleaseChangeFrom{From: "v1.0.0-rc1"},
MakeLatest: &ReleaseChangeToBool{To: true},
},
Release: &RepositoryRelease{
ID: 12345,
TagName: "v1.0.0",
Name: new("Release 1.0.0"),
Body: new("New body"),
},
Enterprise: &Enterprise{
ID: new(1),
Slug: new("octocat-enterprise"),
},
}

if !cmp.Equal(event, want) {
t.Errorf("ParseWebHook() diff (-got +want):\n%v", cmp.Diff(event, want))
}
}
Loading