github

Documentation

Index

• type Asset
• type Client
  • func NewClient(owner, repo, token, baseURL, uploadURL string) *Client
  • func (c *Client) CreatePullRequest(owner string, repo string, message string, head string, base string) (string, error)
  • func (c *Client) CreateRelease(_ context.Context, input *Release) error
  • func (c *Client) GetRelease(_ context.Context, tag string) (*Release, error)
• type Release

Types

type Asset

type Asset struct {
	Path string
	URL  string
}

type Client

type Client struct {
	*github.Client
	// contains filtered or unexported fields
}

Client is the client for interacting with the GitHub API

func NewClient

func NewClient(owner, repo, token, baseURL, uploadURL string) *Client

NewClient creates and initializes a new GitHubClient

func (*Client) CreatePullRequest

func (c *Client) CreatePullRequest(owner string, repo string, message string, head string, base string) (string, error)

CreatePullRequest creates a pull request in the repository specified by repoURL. The return value is the pull request URL.

func (*Client) CreateRelease

func (c *Client) CreateRelease(_ context.Context, input *Release) error

CreateRelease creates a new release object in the GitHub API

func (*Client) GetRelease

func (c *Client) GetRelease(_ context.Context, tag string) (*Release, error)

GetRelease queries the GitHub API for a specified release object

type Release

type Release struct {
	Name                 string
	Description          string
	Assets               []*Asset
	Commit               string
	GenerateReleaseNotes bool
	MakeLatest           string
}