pr

Documentation

Index

• func UpdateMessage(ed editor.Editor, pr *github.PullRequest) error
• type LandRequest
• type LandResponse
• type RebaseRequest
• type RebaseResponse
• type Service
  • func (s *Service) Land(req *LandRequest) (*LandResponse, error)
  • func (s *Service) Rebase(req *RebaseRequest) (_ *RebaseResponse, err error)

Functions

func UpdateMessage

func UpdateMessage(ed editor.Editor, pr *github.PullRequest) error

UpdateMessage uses the given editor to edit the commit message of the given PR.

Types

type LandRequest

type LandRequest struct {
	// PullRqeuest to land
	PullRequest *github.PullRequest

	// Name of the local branch that points to this PR or an empty string if a
	// local branch for this PR is not known.
	LocalBranch string

	// Editor to use for editing the commit message.
	Editor editor.Editor
}

LandRequest is a request to land the given pull request.

type LandResponse

type LandResponse struct {
	BranchesNotUpdated []string
}

LandResponse is the response of a land request.

type RebaseRequest

type RebaseRequest struct {
	PullRequests []*github.PullRequest
	Base         string
}

RebaseRequest is a request to rebase the given list of pull requests and their dependencies onto the given base branch.

If the base branch for the given PRs on GitHub is not the same as Base, this will be updated too.

type RebaseResponse

type RebaseResponse struct {
	// Local branches that were not updated because their heads did not match
	// the remotes.
	BranchesNotUpdated []string
}

RebaseResponse is the response of the Rebase operation.

type Service

type Service struct {
	GitHub gateway.GitHub
	Git    gateway.Git
}

Service TODO

func (*Service) Land

func (s *Service) Land(req *LandRequest) (*LandResponse, error)

Land the given pull request.

func (*Service) Rebase

func (s *Service) Rebase(req *RebaseRequest) (_ *RebaseResponse, err error)

Rebase a pull request and its dependencies.