Upgrade go-github to v39 (#17437)
This commit is contained in:
Lunny Xiao
GitHub
parent
849356deaf
commit
812a9daab9
126 changed files with 2594 additions and 200 deletions
312
vendor/github.com/google/go-github/v39/github/repos_commits.go
generated
vendored
Normal file
312
vendor/github.com/google/go-github/v39/github/repos_commits.go
generated
vendored
Normal file
|
|
@ -0,0 +1,312 @@
|
|||
// Copyright 2013 The go-github AUTHORS. All rights reserved.
|
||||
//
|
||||
// Use of this source code is governed by a BSD-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package github
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"time"
|
||||
)
|
||||
|
||||
// RepositoryCommit represents a commit in a repo.
|
||||
// Note that it's wrapping a Commit, so author/committer information is in two places,
|
||||
// but contain different details about them: in RepositoryCommit "github details", in Commit - "git details".
|
||||
type RepositoryCommit struct {
|
||||
NodeID *string `json:"node_id,omitempty"`
|
||||
SHA *string `json:"sha,omitempty"`
|
||||
Commit *Commit `json:"commit,omitempty"`
|
||||
Author *User `json:"author,omitempty"`
|
||||
Committer *User `json:"committer,omitempty"`
|
||||
Parents []*Commit `json:"parents,omitempty"`
|
||||
HTMLURL *string `json:"html_url,omitempty"`
|
||||
URL *string `json:"url,omitempty"`
|
||||
CommentsURL *string `json:"comments_url,omitempty"`
|
||||
|
||||
// Details about how many changes were made in this commit. Only filled in during GetCommit!
|
||||
Stats *CommitStats `json:"stats,omitempty"`
|
||||
// Details about which files, and how this commit touched. Only filled in during GetCommit!
|
||||
Files []*CommitFile `json:"files,omitempty"`
|
||||
}
|
||||
|
||||
func (r RepositoryCommit) String() string {
|
||||
return Stringify(r)
|
||||
}
|
||||
|
||||
// CommitStats represents the number of additions / deletions from a file in a given RepositoryCommit or GistCommit.
|
||||
type CommitStats struct {
|
||||
Additions *int `json:"additions,omitempty"`
|
||||
Deletions *int `json:"deletions,omitempty"`
|
||||
Total *int `json:"total,omitempty"`
|
||||
}
|
||||
|
||||
func (c CommitStats) String() string {
|
||||
return Stringify(c)
|
||||
}
|
||||
|
||||
// CommitFile represents a file modified in a commit.
|
||||
type CommitFile struct {
|
||||
SHA *string `json:"sha,omitempty"`
|
||||
Filename *string `json:"filename,omitempty"`
|
||||
Additions *int `json:"additions,omitempty"`
|
||||
Deletions *int `json:"deletions,omitempty"`
|
||||
Changes *int `json:"changes,omitempty"`
|
||||
Status *string `json:"status,omitempty"`
|
||||
Patch *string `json:"patch,omitempty"`
|
||||
BlobURL *string `json:"blob_url,omitempty"`
|
||||
RawURL *string `json:"raw_url,omitempty"`
|
||||
ContentsURL *string `json:"contents_url,omitempty"`
|
||||
PreviousFilename *string `json:"previous_filename,omitempty"`
|
||||
}
|
||||
|
||||
func (c CommitFile) String() string {
|
||||
return Stringify(c)
|
||||
}
|
||||
|
||||
// CommitsComparison is the result of comparing two commits.
|
||||
// See CompareCommits() for details.
|
||||
type CommitsComparison struct {
|
||||
BaseCommit *RepositoryCommit `json:"base_commit,omitempty"`
|
||||
MergeBaseCommit *RepositoryCommit `json:"merge_base_commit,omitempty"`
|
||||
|
||||
// Head can be 'behind' or 'ahead'
|
||||
Status *string `json:"status,omitempty"`
|
||||
AheadBy *int `json:"ahead_by,omitempty"`
|
||||
BehindBy *int `json:"behind_by,omitempty"`
|
||||
TotalCommits *int `json:"total_commits,omitempty"`
|
||||
|
||||
Commits []*RepositoryCommit `json:"commits,omitempty"`
|
||||
|
||||
Files []*CommitFile `json:"files,omitempty"`
|
||||
|
||||
HTMLURL *string `json:"html_url,omitempty"`
|
||||
PermalinkURL *string `json:"permalink_url,omitempty"`
|
||||
DiffURL *string `json:"diff_url,omitempty"`
|
||||
PatchURL *string `json:"patch_url,omitempty"`
|
||||
URL *string `json:"url,omitempty"` // API URL.
|
||||
}
|
||||
|
||||
func (c CommitsComparison) String() string {
|
||||
return Stringify(c)
|
||||
}
|
||||
|
||||
// CommitsListOptions specifies the optional parameters to the
|
||||
// RepositoriesService.ListCommits method.
|
||||
type CommitsListOptions struct {
|
||||
// SHA or branch to start listing Commits from.
|
||||
SHA string `url:"sha,omitempty"`
|
||||
|
||||
// Path that should be touched by the returned Commits.
|
||||
Path string `url:"path,omitempty"`
|
||||
|
||||
// Author of by which to filter Commits.
|
||||
Author string `url:"author,omitempty"`
|
||||
|
||||
// Since when should Commits be included in the response.
|
||||
Since time.Time `url:"since,omitempty"`
|
||||
|
||||
// Until when should Commits be included in the response.
|
||||
Until time.Time `url:"until,omitempty"`
|
||||
|
||||
ListOptions
|
||||
}
|
||||
|
||||
// BranchCommit is the result of listing branches with commit SHA.
|
||||
type BranchCommit struct {
|
||||
Name *string `json:"name,omitempty"`
|
||||
Commit *Commit `json:"commit,omitempty"`
|
||||
Protected *bool `json:"protected,omitempty"`
|
||||
}
|
||||
|
||||
// ListCommits lists the commits of a repository.
|
||||
//
|
||||
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-commits
|
||||
func (s *RepositoriesService) ListCommits(ctx context.Context, owner, repo string, opts *CommitsListOptions) ([]*RepositoryCommit, *Response, error) {
|
||||
u := fmt.Sprintf("repos/%v/%v/commits", owner, repo)
|
||||
u, err := addOptions(u, opts)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
req, err := s.client.NewRequest("GET", u, nil)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
var commits []*RepositoryCommit
|
||||
resp, err := s.client.Do(ctx, req, &commits)
|
||||
if err != nil {
|
||||
return nil, resp, err
|
||||
}
|
||||
|
||||
return commits, resp, nil
|
||||
}
|
||||
|
||||
// GetCommit fetches the specified commit, including all details about it.
|
||||
//
|
||||
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-single-commit
|
||||
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-commit
|
||||
func (s *RepositoriesService) GetCommit(ctx context.Context, owner, repo, sha string, opts *ListOptions) (*RepositoryCommit, *Response, error) {
|
||||
u := fmt.Sprintf("repos/%v/%v/commits/%v", owner, repo, sha)
|
||||
u, err := addOptions(u, opts)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
req, err := s.client.NewRequest("GET", u, nil)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
commit := new(RepositoryCommit)
|
||||
resp, err := s.client.Do(ctx, req, commit)
|
||||
if err != nil {
|
||||
return nil, resp, err
|
||||
}
|
||||
|
||||
return commit, resp, nil
|
||||
}
|
||||
|
||||
// GetCommitRaw fetches the specified commit in raw (diff or patch) format.
|
||||
//
|
||||
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-commit
|
||||
func (s *RepositoriesService) GetCommitRaw(ctx context.Context, owner string, repo string, sha string, opts RawOptions) (string, *Response, error) {
|
||||
u := fmt.Sprintf("repos/%v/%v/commits/%v", owner, repo, sha)
|
||||
req, err := s.client.NewRequest("GET", u, nil)
|
||||
if err != nil {
|
||||
return "", nil, err
|
||||
}
|
||||
|
||||
switch opts.Type {
|
||||
case Diff:
|
||||
req.Header.Set("Accept", mediaTypeV3Diff)
|
||||
case Patch:
|
||||
req.Header.Set("Accept", mediaTypeV3Patch)
|
||||
default:
|
||||
return "", nil, fmt.Errorf("unsupported raw type %d", opts.Type)
|
||||
}
|
||||
|
||||
var buf bytes.Buffer
|
||||
resp, err := s.client.Do(ctx, req, &buf)
|
||||
if err != nil {
|
||||
return "", resp, err
|
||||
}
|
||||
|
||||
return buf.String(), resp, nil
|
||||
}
|
||||
|
||||
// GetCommitSHA1 gets the SHA-1 of a commit reference. If a last-known SHA1 is
|
||||
// supplied and no new commits have occurred, a 304 Unmodified response is returned.
|
||||
//
|
||||
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-commit
|
||||
func (s *RepositoriesService) GetCommitSHA1(ctx context.Context, owner, repo, ref, lastSHA string) (string, *Response, error) {
|
||||
u := fmt.Sprintf("repos/%v/%v/commits/%v", owner, repo, refURLEscape(ref))
|
||||
|
||||
req, err := s.client.NewRequest("GET", u, nil)
|
||||
if err != nil {
|
||||
return "", nil, err
|
||||
}
|
||||
if lastSHA != "" {
|
||||
req.Header.Set("If-None-Match", `"`+lastSHA+`"`)
|
||||
}
|
||||
|
||||
req.Header.Set("Accept", mediaTypeV3SHA)
|
||||
|
||||
var buf bytes.Buffer
|
||||
resp, err := s.client.Do(ctx, req, &buf)
|
||||
if err != nil {
|
||||
return "", resp, err
|
||||
}
|
||||
|
||||
return buf.String(), resp, nil
|
||||
}
|
||||
|
||||
// CompareCommits compares a range of commits with each other.
|
||||
//
|
||||
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#compare-two-commits
|
||||
func (s *RepositoriesService) CompareCommits(ctx context.Context, owner, repo string, base, head string, opts *ListOptions) (*CommitsComparison, *Response, error) {
|
||||
escapedBase := url.QueryEscape(base)
|
||||
escapedHead := url.QueryEscape(head)
|
||||
|
||||
u := fmt.Sprintf("repos/%v/%v/compare/%v...%v", owner, repo, escapedBase, escapedHead)
|
||||
u, err := addOptions(u, opts)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
req, err := s.client.NewRequest("GET", u, nil)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
comp := new(CommitsComparison)
|
||||
resp, err := s.client.Do(ctx, req, comp)
|
||||
if err != nil {
|
||||
return nil, resp, err
|
||||
}
|
||||
|
||||
return comp, resp, nil
|
||||
}
|
||||
|
||||
// CompareCommitsRaw compares a range of commits with each other in raw (diff or patch) format.
|
||||
//
|
||||
// Both "base" and "head" must be branch names in "repo".
|
||||
// To compare branches across other repositories in the same network as "repo",
|
||||
// use the format "<USERNAME>:branch".
|
||||
//
|
||||
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#compare-two-commits
|
||||
func (s *RepositoriesService) CompareCommitsRaw(ctx context.Context, owner, repo, base, head string, opts RawOptions) (string, *Response, error) {
|
||||
escapedBase := url.QueryEscape(base)
|
||||
escapedHead := url.QueryEscape(head)
|
||||
|
||||
u := fmt.Sprintf("repos/%v/%v/compare/%v...%v", owner, repo, escapedBase, escapedHead)
|
||||
|
||||
req, err := s.client.NewRequest("GET", u, nil)
|
||||
if err != nil {
|
||||
return "", nil, err
|
||||
}
|
||||
|
||||
switch opts.Type {
|
||||
case Diff:
|
||||
req.Header.Set("Accept", mediaTypeV3Diff)
|
||||
case Patch:
|
||||
req.Header.Set("Accept", mediaTypeV3Patch)
|
||||
default:
|
||||
return "", nil, fmt.Errorf("unsupported raw type %d", opts.Type)
|
||||
}
|
||||
|
||||
var buf bytes.Buffer
|
||||
resp, err := s.client.Do(ctx, req, &buf)
|
||||
if err != nil {
|
||||
return "", resp, err
|
||||
}
|
||||
|
||||
return buf.String(), resp, nil
|
||||
}
|
||||
|
||||
// ListBranchesHeadCommit gets all branches where the given commit SHA is the HEAD,
|
||||
// or latest commit for the branch.
|
||||
//
|
||||
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-branches-for-head-commit
|
||||
func (s *RepositoriesService) ListBranchesHeadCommit(ctx context.Context, owner, repo, sha string) ([]*BranchCommit, *Response, error) {
|
||||
u := fmt.Sprintf("repos/%v/%v/commits/%v/branches-where-head", owner, repo, sha)
|
||||
|
||||
req, err := s.client.NewRequest("GET", u, nil)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
// TODO: remove custom Accept header when this API fully launches.
|
||||
req.Header.Set("Accept", mediaTypeListPullsOrBranchesForCommitPreview)
|
||||
var branchCommits []*BranchCommit
|
||||
resp, err := s.client.Do(ctx, req, &branchCommits)
|
||||
if err != nil {
|
||||
return nil, resp, err
|
||||
}
|
||||
|
||||
return branchCommits, resp, nil
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue