githubclt

Documentation

Overview

Package githubclt provides a github API client.

Index

• Constants
• Variables
• type Client
  • func New(oauthAPItoken string) *Client
  • func (clt *Client) BranchIsBehindBase(ctx context.Context, owner, repo, base, head string) (behind bool, err error)
  • func (clt *Client) PRIsUptodate(ctx context.Context, owner, repo string, pullRequestNumber int) (isUptodate bool, headSHA string, err error)
  • func (clt *Client) RemoveLabel(ctx context.Context, owner, repo string, pullRequestOrIssueNumber int, ...) error
  • func (clt *Client) UpdateBranch(ctx context.Context, owner, repo string, pullRequestNumber int) (*UpdateBranchResult, error)
• type UpdateBranchResult

Constants

const DefaultHTTPClientTimeout = time.Minute

Variables

var ErrPullRequestIsClosed = errors.New("pull request is closed")

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is an github API client. All methods return a goorderr.RetryableError when an operation can be retried. This can be e.g. the case when the API ratelimit is exceeded.

func New

func New(oauthAPItoken string) *Client

New returns a new github api client.

func (*Client) BranchIsBehindBase

func (clt *Client) BranchIsBehindBase(ctx context.Context, owner, repo, base, head string) (behind bool, err error)

BranchIsBehindBase returns true if the head reference contains all changes of base.

func (*Client) PRIsUptodate

func (clt *Client) PRIsUptodate(ctx context.Context, owner, repo string, pullRequestNumber int) (isUptodate bool, headSHA string, err error)

PRIsUptodate returns true if the pull request is open and contains all changes from it's base branch. Additionally it returns the SHA of the head commit for which the status was checked. If the PR is closed ErrPullRequestIsClosed is returned.

func (*Client) RemoveLabel

func (clt *Client) RemoveLabel(ctx context.Context, owner, repo string, pullRequestOrIssueNumber int, label string) error

RemoveLabel removes a label from a Pull-Request or issue. If the issue or PR does not have the label, the operation succeeds.

func (*Client) UpdateBranch

func (clt *Client) UpdateBranch(ctx context.Context, owner, repo string, pullRequestNumber int) (*UpdateBranchResult, error)

UpdateBranch schedules merging the base-branch into a pull request branch. If the PR contains all changes of it's base branch, false is returned for changed If it's not up-to-date and updating the PR was scheduled at github, true is returned for changed and scheduled. If the PR was updated while the method was executed, a goorderr.RetryableError is returned and the operation can be retried. If the branch can not be updated automatically because of a merge conflict, an error is returned.

type UpdateBranchResult

type UpdateBranchResult struct {
	Changed      bool
	Scheduled    bool
	HeadCommitID string
}