Skip to content

docs: Add clarifications for mergeable field in pull requests #3396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 30, 2025
Merged

docs: Add clarifications for mergeable field in pull requests #3396

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76addbe
docs: add clarifications for mergeable field in pull requests
acouvreur Dec 21, 2024
8a34bd0
pr feedback
acouvreur Dec 27, 2024
dd2c798
format
acouvreur Jan 30, 2025
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
Next Next commit
docs: add clarifications for mergeable field in pull requests
  • Loading branch information
@acouvreur
acouvreur committed Jan 30, 2025
commit 76addbe99bb57015d2261c2f7d97c4bc74edc340
100 changes: 57 additions & 43 deletions github/pulls.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,49 +28,63 @@ type PullRequestAutoMerge struct {

// PullRequest represents a GitHub pull request on a repository.
type PullRequest struct {
ID *int64 `json:"id,omitempty"`
Number *int `json:"number,omitempty"`
State *string `json:"state,omitempty"`
Locked *bool `json:"locked,omitempty"`
Title *string `json:"title,omitempty"`
Body *string `json:"body,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
ClosedAt *Timestamp `json:"closed_at,omitempty"`
MergedAt *Timestamp `json:"merged_at,omitempty"`
Labels []*Label `json:"labels,omitempty"`
User *User `json:"user,omitempty"`
Draft *bool `json:"draft,omitempty"`
Merged *bool `json:"merged,omitempty"`
Mergeable *bool `json:"mergeable,omitempty"`
MergeableState *string `json:"mergeable_state,omitempty"`
MergedBy *User `json:"merged_by,omitempty"`
MergeCommitSHA *string `json:"merge_commit_sha,omitempty"`
Rebaseable *bool `json:"rebaseable,omitempty"`
Comments *int `json:"comments,omitempty"`
Commits *int `json:"commits,omitempty"`
Additions *int `json:"additions,omitempty"`
Deletions *int `json:"deletions,omitempty"`
ChangedFiles *int `json:"changed_files,omitempty"`
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
IssueURL *string `json:"issue_url,omitempty"`
StatusesURL *string `json:"statuses_url,omitempty"`
DiffURL *string `json:"diff_url,omitempty"`
PatchURL *string `json:"patch_url,omitempty"`
CommitsURL *string `json:"commits_url,omitempty"`
CommentsURL *string `json:"comments_url,omitempty"`
ReviewCommentsURL *string `json:"review_comments_url,omitempty"`
ReviewCommentURL *string `json:"review_comment_url,omitempty"`
ReviewComments *int `json:"review_comments,omitempty"`
Assignee *User `json:"assignee,omitempty"`
Assignees []*User `json:"assignees,omitempty"`
Milestone *Milestone `json:"milestone,omitempty"`
MaintainerCanModify *bool `json:"maintainer_can_modify,omitempty"`
AuthorAssociation *string `json:"author_association,omitempty"`
NodeID *string `json:"node_id,omitempty"`
RequestedReviewers []*User `json:"requested_reviewers,omitempty"`
AutoMerge *PullRequestAutoMerge `json:"auto_merge,omitempty"`
ID *int64 `json:"id,omitempty"`
Number *int `json:"number,omitempty"`
State *string `json:"state,omitempty"`
Locked *bool `json:"locked,omitempty"`
Title *string `json:"title,omitempty"`
Body *string `json:"body,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
ClosedAt *Timestamp `json:"closed_at,omitempty"`
MergedAt *Timestamp `json:"merged_at,omitempty"`
Labels []*Label `json:"labels,omitempty"`
User *User `json:"user,omitempty"`
Draft *bool `json:"draft,omitempty"`
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
IssueURL *string `json:"issue_url,omitempty"`
StatusesURL *string `json:"statuses_url,omitempty"`
DiffURL *string `json:"diff_url,omitempty"`
PatchURL *string `json:"patch_url,omitempty"`
CommitsURL *string `json:"commits_url,omitempty"`
CommentsURL *string `json:"comments_url,omitempty"`
ReviewCommentsURL *string `json:"review_comments_url,omitempty"`
ReviewCommentURL *string `json:"review_comment_url,omitempty"`
Assignee *User `json:"assignee,omitempty"`
Assignees []*User `json:"assignees,omitempty"`
Milestone *Milestone `json:"milestone,omitempty"`
AuthorAssociation *string `json:"author_association,omitempty"`
NodeID *string `json:"node_id,omitempty"`
RequestedReviewers []*User `json:"requested_reviewers,omitempty"`
AutoMerge *PullRequestAutoMerge `json:"auto_merge,omitempty"`

// Merged is not populated by List operation.
Merged *bool `json:"merged,omitempty"`
// Mergeable is not populated by List operation.
Mergeable *bool `json:"mergeable,omitempty"`
// MergeableState is not populated by List operation.
MergeableState *string `json:"mergeable_state,omitempty"`
// Rebaseable is not populated by List operation.
Rebaseable *bool `json:"rebaseable,omitempty"`
// MergedBy is not populated by List operation.
MergedBy *User `json:"merged_by,omitempty"`
// MergeCommitSHA is not populated by List operation.
MergeCommitSHA *string `json:"merge_commit_sha,omitempty"`
// Comments is not populated by List operation.
Comments *int `json:"comments,omitempty"`
// Commits is not populated by List operation.
Commits *int `json:"commits,omitempty"`
// Additions are not populated by List operation.
Additions *int `json:"additions,omitempty"`
// Deletions are not populated by List operation.
Deletions *int `json:"deletions,omitempty"`
// ChangedFiles is not populated by List operation.
ChangedFiles *int `json:"changed_files,omitempty"`
// MaintainerCanModify is not populated by List operation.
MaintainerCanModify *bool `json:"maintainer_can_modify,omitempty"`
// ReviewComments is not populated by List operation.
ReviewComments *int `json:"review_comments,omitempty"`

// RequestedTeams is populated as part of the PullRequestEvent.
// See, https://docs.github.com/developers/webhooks-and-events/github-event-types#pullrequestevent for an example.
Expand Down