open-vault/vendor/github.com/google/go-github/github/git_commits.go

134 lines
4.1 KiB
Go
Raw Normal View History

2015-04-27 23:19:51 +00:00
// 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 (
2017-02-24 19:36:54 +00:00
"context"
2015-04-27 23:19:51 +00:00
"fmt"
"time"
)
2016-06-30 18:19:03 +00:00
// SignatureVerification represents GPG signature verification.
type SignatureVerification struct {
Verified *bool `json:"verified,omitempty"`
Reason *string `json:"reason,omitempty"`
Signature *string `json:"signature,omitempty"`
Payload *string `json:"payload,omitempty"`
}
2015-04-27 23:19:51 +00:00
// Commit represents a GitHub commit.
type Commit struct {
2016-06-30 18:19:03 +00:00
SHA *string `json:"sha,omitempty"`
Author *CommitAuthor `json:"author,omitempty"`
Committer *CommitAuthor `json:"committer,omitempty"`
Message *string `json:"message,omitempty"`
Tree *Tree `json:"tree,omitempty"`
Parents []Commit `json:"parents,omitempty"`
Stats *CommitStats `json:"stats,omitempty"`
2017-04-17 15:17:06 +00:00
HTMLURL *string `json:"html_url,omitempty"`
2016-06-30 18:19:03 +00:00
URL *string `json:"url,omitempty"`
Verification *SignatureVerification `json:"verification,omitempty"`
2015-04-27 23:19:51 +00:00
// CommentCount is the number of GitHub comments on the commit. This
2015-04-27 23:19:51 +00:00
// is only populated for requests that fetch GitHub data like
// Pulls.ListCommits, Repositories.ListCommits, etc.
CommentCount *int `json:"comment_count,omitempty"`
}
func (c Commit) String() string {
return Stringify(c)
}
// CommitAuthor represents the author or committer of a commit. The commit
2015-04-27 23:19:51 +00:00
// author may not correspond to a GitHub User.
type CommitAuthor struct {
Date *time.Time `json:"date,omitempty"`
Name *string `json:"name,omitempty"`
Email *string `json:"email,omitempty"`
2016-03-11 03:50:44 +00:00
// The following fields are only populated by Webhook events.
Login *string `json:"username,omitempty"` // Renamed for go-github consistency.
2015-04-27 23:19:51 +00:00
}
func (c CommitAuthor) String() string {
return Stringify(c)
}
// GetCommit fetchs the Commit object for a given SHA.
//
2017-02-24 19:36:54 +00:00
// GitHub API docs: https://developer.github.com/v3/git/commits/#get-a-commit
func (s *GitService) GetCommit(ctx context.Context, owner string, repo string, sha string) (*Commit, *Response, error) {
2015-04-27 23:19:51 +00:00
u := fmt.Sprintf("repos/%v/%v/git/commits/%v", owner, repo, sha)
req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}
2016-06-30 18:19:03 +00:00
// TODO: remove custom Accept header when this API fully launches.
req.Header.Set("Accept", mediaTypeGitSigningPreview)
2015-04-27 23:19:51 +00:00
c := new(Commit)
2017-02-24 19:36:54 +00:00
resp, err := s.client.Do(ctx, req, c)
2015-04-27 23:19:51 +00:00
if err != nil {
return nil, resp, err
}
return c, resp, nil
2015-04-27 23:19:51 +00:00
}
// createCommit represents the body of a CreateCommit request.
type createCommit struct {
Author *CommitAuthor `json:"author,omitempty"`
Committer *CommitAuthor `json:"committer,omitempty"`
Message *string `json:"message,omitempty"`
Tree *string `json:"tree,omitempty"`
Parents []string `json:"parents,omitempty"`
}
// CreateCommit creates a new commit in a repository.
2017-03-31 00:03:13 +00:00
// commit must not be nil.
2015-04-27 23:19:51 +00:00
//
// The commit.Committer is optional and will be filled with the commit.Author
// data if omitted. If the commit.Author is omitted, it will be filled in with
// the authenticated users information and the current date.
//
2017-02-24 19:36:54 +00:00
// GitHub API docs: https://developer.github.com/v3/git/commits/#create-a-commit
func (s *GitService) CreateCommit(ctx context.Context, owner string, repo string, commit *Commit) (*Commit, *Response, error) {
2017-03-31 00:03:13 +00:00
if commit == nil {
return nil, nil, fmt.Errorf("commit must be provided")
}
2015-04-27 23:19:51 +00:00
u := fmt.Sprintf("repos/%v/%v/git/commits", owner, repo)
2017-03-31 00:03:13 +00:00
parents := make([]string, len(commit.Parents))
for i, parent := range commit.Parents {
parents[i] = *parent.SHA
}
body := &createCommit{
Author: commit.Author,
Committer: commit.Committer,
Message: commit.Message,
Parents: parents,
}
if commit.Tree != nil {
body.Tree = commit.Tree.SHA
2015-04-27 23:19:51 +00:00
}
req, err := s.client.NewRequest("POST", u, body)
if err != nil {
return nil, nil, err
}
c := new(Commit)
2017-02-24 19:36:54 +00:00
resp, err := s.client.Do(ctx, req, c)
2015-04-27 23:19:51 +00:00
if err != nil {
return nil, resp, err
}
return c, resp, nil
2015-04-27 23:19:51 +00:00
}