actions

Documentation

Index

• func CreatePullRequest(ctx context.Context, repo *git.Repo, client *gh.Client, ...) (*gh.PullRequest, error)
• func Push(repo *git.Repo, opts PushOpts) error
• type CreatePullRequestOpts
• type ForceOpt
• type PushOpts

Functions

func CreatePullRequest

func CreatePullRequest(ctx context.Context, repo *git.Repo, client *gh.Client, opts CreatePullRequestOpts) (*gh.PullRequest, error)

CreatePullRequest creates a pull request on GitHub for the current branch, if one doesn't already exist.

func Push

func Push(repo *git.Repo, opts PushOpts) error

Push pushes the current branch to the Git origin. It does not check out the given branch.

Types

type CreatePullRequestOpts

type CreatePullRequestOpts struct {
	Title string
	Body  string

	// If true, do not push the branch to GitHub
	SkipPush bool
	// If true, create a PR even if we think one already exists
	Force bool
}

type ForceOpt

type ForceOpt int

const (
	NoForce ForceOpt = iota
	// ForceWithLease indicates that the push should use the --force-with-lease
	// option which instructs Git that it should only force push to the remote
	// branch if its current HEAD matches what we think it should be.
	ForceWithLease ForceOpt = iota
	ForcePush      ForceOpt = iota
)

type PushOpts

type PushOpts struct {
	Force ForceOpt
}