actions

Documentation

Index

• Constants
• func AddPRMetadataAndStack(body string, prMeta PRMetadata, branchName string, ...) string
• func AddPullRequestReviewers(ctx context.Context, client *gh.Client, prID githubv4.ID, reviewers []string) error
• func OpenPullRequestInBrowser(pullRequestLink string)
• func TidyDB(repo *git.Repo, db meta.DB) (map[string]bool, map[string]bool, error)
• func UpdatePullRequestWithStack(ctx context.Context, client *gh.Client, tx meta.WriteTx, branchName string) error
• func UpdatePullRequestsWithStack(ctx context.Context, client *gh.Client, tx meta.WriteTx, branchNames []string) error
• type CreatePullRequestOpts
• type CreatePullRequestResult
  • func CreatePullRequest(ctx context.Context, repo *git.Repo, client *gh.Client, tx meta.WriteTx, ...) (_ *CreatePullRequestResult, reterr error)
• type ErrExitSilently
  • func (e ErrExitSilently) Error() string
• type PRMetadata
  • func ParsePRBody(input string) (body string, prMeta PRMetadata, retErr error)
  • func ReadPRMetadata(body string) (PRMetadata, error)
• type UpdatePullRequestResult
  • func UpdatePullRequestState(ctx context.Context, client *gh.Client, tx meta.WriteTx, branchName string) (*UpdatePullRequestResult, error)

Constants

const PRMetadataCommentEnd = "-->"

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

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

const PRStackCommentEnd = "<!-- av pr stack end -->"

const PRStackCommentStart = "<!-- av pr stack begin -->"

Functions

func AddPRMetadataAndStack

func AddPRMetadataAndStack(
	body string,
	prMeta PRMetadata,
	branchName string,
	stack *stackutils.StackTreeNode,
	tx meta.ReadTx,
) string

func AddPullRequestReviewers

func AddPullRequestReviewers(
	ctx context.Context,
	client *gh.Client,
	prID githubv4.ID,
	reviewers []string,
) error

AddPullRequestReviewers adds the given reviewers to the given pull request. It accepts a list of reviewers, which can be either GitHub user logins or team names in the format `@organization/team`.

func OpenPullRequestInBrowser

func OpenPullRequestInBrowser(pullRequestLink string)

func TidyDB

func TidyDB(repo *git.Repo, db meta.DB) (map[string]bool, map[string]bool, error)

TidyDB removes deleted branches from the metadata and returns number of branches removed from the DB.

func UpdatePullRequestWithStack

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

UpdatePullRequestWithStack updates the GitHub pull request associated with the given branch to include the stack of branches that the branch is a part of. This should be called after all applicable PRs have been created to ensure we can properly link them.

func UpdatePullRequestsWithStack

func UpdatePullRequestsWithStack(
	ctx context.Context,
	client *gh.Client,
	tx meta.WriteTx,
	branchNames []string,
) error

UpdatePullRequestsWithStack updates the GitHub pull requests associated with the given branches to include the stack of branches that each branch is a part of.

Types

type CreatePullRequestOpts

type CreatePullRequestOpts struct {
	// The HEAD branch to create a pull request for.
	BranchName string
	// The pull request title.
	Title string
	// The pull request body (description).
	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
	// If true, do not open the browser after creating the PR
	NoOpenBrowser 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 ErrExitSilently

type ErrExitSilently struct {
	ExitCode int
}

errExitSilently is an error type that indicates that program should exit without printing any additional information with the given exit code. This is meant for cases where the running commands wants to manage its own error output but still needs to return a non-zero exit code (since returning nil from RunE would cause a exit with a zero code).

func (ErrExitSilently) Error

func (e ErrExitSilently) Error() string

type PRMetadata

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

func ParsePRBody

func ParsePRBody(input string) (body string, prMeta PRMetadata, retErr error)

func ReadPRMetadata

func ReadPRMetadata(body string) (PRMetadata, error)

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.