actions

Documentation

Index

• Constants
• Variables
• func AddPRMetadata(body string, prMeta PRMetadata) string
• func Push(repo *git.Repo, opts PushOpts) error
• type CreatePullRequestOpts
• type CreatePullRequestResult
  • func CreatePullRequest(ctx context.Context, repo *git.Repo, client *gh.Client, tx meta.WriteTx, ...) (_ *CreatePullRequestResult, reterr error)
• type ForceOpt
• type PRMetadata
  • func ParsePRMetadata(input string) (commentStart int, commentEnd int, prMeta PRMetadata, reterr error)
  • func ReadPRMetadata(body string) (PRMetadata, error)
• type PushOpts
• type ReparentOpts
• type ReparentResult
  • func Reparent(repo *git.Repo, tx meta.WriteTx, opts ReparentOpts) (*ReparentResult, error)
  • func ReparentSkipContinue(repo *git.Repo, tx meta.WriteTx, opts ReparentOpts, skip bool) (*ReparentResult, error)
• type SyncBranchContinuation
  • func SyncBranch(ctx context.Context, repo *git.Repo, client *gh.Client, tx meta.WriteTx, ...) (*SyncBranchContinuation, error)
• type SyncBranchOpts
• type UpdatePullRequestResult
  • func UpdatePullRequestState(ctx context.Context, client *gh.Client, tx meta.WriteTx, branchName string) (*UpdatePullRequestResult, error)

Constants

const PRMetadataCommentEnd = "-->\n"

const PRMetadataCommentHelpText = "" /* 165-byte string literal not displayed */

const PRMetadataCommentStart = "<!-- av pr metadata\n"

Variables

var ErrRepoNotInitialized = errors.Sentinel("this repository is not initialized; please run `av init`")

Functions

func AddPRMetadata

func AddPRMetadata(body string, prMeta PRMetadata) string

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 {
	BranchName string
	Title      string
	Body       string

	// If true, create the pull request as a GitHub draft PR.
	Draft bool
	// If true, do not push the branch to GitHub
	NoPush bool
	// If true, force push the branch to GitHub
	ForcePush bool
	// If true, create a PR even if we think one already exists
	Force bool

	// If true, open an editor for editing the title and body
	Edit bool
}

type CreatePullRequestResult

type CreatePullRequestResult struct {
	// True if the pull request was created
	Created bool
	// The (updated) branch metadata.
	Branch meta.Branch
	// The pull request object that was returned from GitHub
	Pull *gh.PullRequest
}

func CreatePullRequest

func CreatePullRequest(
	ctx context.Context,
	repo *git.Repo,
	client *gh.Client,
	tx meta.WriteTx,
	opts CreatePullRequestOpts,
) (_ *CreatePullRequestResult, reterr error)

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

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 PRMetadata

type PRMetadata struct {
	Parent     string `json:"parent"`
	ParentHead string `json:"parentHead"`
	ParentPull int64  `json:"parentPull,omitempty"`
	Trunk      string `json:"trunk"`
}

func ParsePRMetadata

func ParsePRMetadata(input string) (commentStart int, commentEnd int, prMeta PRMetadata, reterr error)

func ReadPRMetadata

func ReadPRMetadata(body string) (PRMetadata, error)

type PushOpts

type PushOpts struct {
	Force ForceOpt
	// If true, require the corresponding branch exist on the remote (otherwise, don't push).
	SkipIfRemoteBranchNotExist bool
	// If true, skip pushing the branch if the corresponding branch on the remote points to the
	// same commit as the local HEAD commit. The caller should probably call `git fetch` before
	// running this to make sure remote tracking information is up-to-date.
	SkipIfRemoteBranchIsUpToDate bool
}

type ReparentOpts

type ReparentOpts struct {
	// The name of the branch to re-parent.
	Branch string
	// The new parent branch to re-parent the branch to.
	NewParent string
	// If true, consider the NewParent a trunk branch.
	NewParentTrunk bool
}

type ReparentResult

type ReparentResult struct {
	Success bool
	Hint    string
}

func Reparent

func Reparent(
	repo *git.Repo,
	tx meta.WriteTx,
	opts ReparentOpts,
) (*ReparentResult, error)

Reparent changes the parent branch of a stacked branch (performing a rebase if necessary).

func ReparentSkipContinue

func ReparentSkipContinue(repo *git.Repo, tx meta.WriteTx, opts ReparentOpts, skip bool) (*ReparentResult, error)

type SyncBranchContinuation

type SyncBranchContinuation struct {
	// The new parent name.
	NewParentName string `json:"parentName"`
	// If set, set this as the parent HEAD. If unset, the parent is treated as trunk.
	NewParentCommit string `json:"parentCommit"`
}

func SyncBranch

func SyncBranch(
	ctx context.Context,
	repo *git.Repo,
	client *gh.Client,
	tx meta.WriteTx,
	opts SyncBranchOpts,
) (*SyncBranchContinuation, error)

SyncBranch synchronizes a branch with its parent.

type SyncBranchOpts

type SyncBranchOpts struct {
	Branch string
	Fetch  bool
	Push   bool
	// If specified, synchronize the branch against the latest version of the
	// trunk branch. This value is ignored if the branch is not a stack root.
	ToTrunk bool
	Skip    bool

	Continuation *SyncBranchContinuation
}

type UpdatePullRequestResult

type UpdatePullRequestResult struct {
	// True if the pull request information changed (e.g., a new pull request
	// was found or if the pull request changed state)
	Changed bool
	// The pull request object that was returned from GitHub
	Pull *gh.PullRequest
}

func UpdatePullRequestState

func UpdatePullRequestState(
	ctx context.Context,
	client *gh.Client,
	tx meta.WriteTx,
	branchName string,
) (*UpdatePullRequestResult, error)

UpdatePullRequestState fetches the latest pull request information from GitHub and writes the relevant branch metadata.