legacy

Documentation

Index

• type Client
  • func NewClient(ctx context.Context, accessToken string) *Client
  • func (c *Client) CreateBranch(ctx context.Context, req CreateBranchRequest) (*github.Reference, *github.Response, error)
  • func (c *Client) CreatePullRequest(ctx context.Context, req CreatePRRequest) (*github.PullRequest, *github.Response, error)
  • func (c *Client) GetBranch(ctx context.Context, req GetBranchRequest) (*github.Reference, *github.Response, error)
  • func (c *Client) GetRepositoryContents(ctx context.Context, req GetRepositoryContentsRequest) (fileContent *github.RepositoryContent, ...)
  • func (c *Client) GetRepositoryReleases(ctx context.Context, req CommonRequest) ([]*github.RepositoryRelease, *github.Response, error)
  • func (c *Client) UpdateFile(ctx context.Context, req UpdateFileRequest) (*github.RepositoryContentResponse, *github.Response, error)
• type CommonRequest
• type CreateBranchRequest
• type CreatePRRequest
• type GetBranchRequest
• type GetReleaseRequest
• type GetRepositoryContentsRequest
• type Interface
• type UpdateFileRequest

Types

type Client

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

func NewClient

func NewClient(ctx context.Context, accessToken string) *Client

func (*Client) CreateBranch

func (c *Client) CreateBranch(ctx context.Context, req CreateBranchRequest) (*github.Reference, *github.Response, error)

func (*Client) CreatePullRequest

func (c *Client) CreatePullRequest(ctx context.Context, req CreatePRRequest) (*github.PullRequest, *github.Response, error)

func (*Client) GetBranch

func (c *Client) GetBranch(ctx context.Context, req GetBranchRequest) (*github.Reference, *github.Response, error)

func (*Client) GetRepositoryContents

func (c *Client) GetRepositoryContents(ctx context.Context, req GetRepositoryContentsRequest) (fileContent *github.RepositoryContent, directoryContent []*github.RepositoryContent, resp *github.Response, err error)

func (*Client) GetRepositoryReleases

func (c *Client) GetRepositoryReleases(ctx context.Context, req CommonRequest) ([]*github.RepositoryRelease, *github.Response, error)

func (*Client) UpdateFile

func (c *Client) UpdateFile(ctx context.Context, req UpdateFileRequest) (*github.RepositoryContentResponse, *github.Response, error)

type CommonRequest

type CommonRequest struct {
	Owner string
	Repo  string
}

type CreateBranchRequest

type CreateBranchRequest struct {
	Owner string
	Repo  string
	*github.Reference
}

type CreatePRRequest

type CreatePRRequest struct {
	Owner string
	Repo  string
	*github.NewPullRequest
}

type GetBranchRequest

type GetBranchRequest struct {
	Owner      string
	Repo       string
	BranchName string
}

type GetReleaseRequest

type GetReleaseRequest struct {
	Owner     string
	Repo      string
	ReleaseID int64
}

type GetRepositoryContentsRequest

type GetRepositoryContentsRequest struct {
	Owner  string
	Repo   string
	Path   string
	Branch string
}

type Interface

type Interface interface {
	// GetRepositoryContents
	//
	// Fetches a specific file/folder in a github repo on a given branch.
	GetRepositoryContents(ctx context.Context, req GetRepositoryContentsRequest) (fileContent *github.RepositoryContent, directoryContent []*github.RepositoryContent, resp *github.Response, err error)

	// GetRepositoryReleases
	//
	// Get all releases from a given repository.
	GetRepositoryReleases(ctx context.Context, req CommonRequest) ([]*github.RepositoryRelease, *github.Response, error)

	// GetBranch
	//
	// Returns a branch given a branch name.
	GetBranch(ctx context.Context, req GetBranchRequest) (*github.Reference, *github.Response, error)

	// CreatePullRequest
	//
	// Creates a Pull Requests on a given repository.
	CreatePullRequest(ctx context.Context, req CreatePRRequest) (*github.PullRequest, *github.Response, error)

	// CreateBranch
	//
	// Creates a branch on a given repository.
	CreateBranch(ctx context.Context, req CreateBranchRequest) (*github.Reference, *github.Response, error)

	// UpdateFile
	//
	// Updates a file in a given repo with new content.
	UpdateFile(ctx context.Context, req UpdateFileRequest) (*github.RepositoryContentResponse, *github.Response, error)
}

type UpdateFileRequest

type UpdateFileRequest struct {
	Owner    string
	Repo     string
	FilePath string
	*github.RepositoryContentFileOptions
}