tools

Documentation

Index

• Constants
• type CreatePullRequestOptions
• type PullRequest
  • func CreatePullRequest(ctx context.Context, opts CreatePullRequestOptions) (*PullRequest, error)
• type Repository

Constants

const (
	CommandCreatePullRequest         = "create-pullrequest"
	FlagCreatePullRequestDir         = "dir"
	FlagCreatePullRequestTitle       = "title"
	FlagCreatePullRequestBody        = "body"
	FlagCreatePullRequestHead        = "head"
	FlagCreatePullRequestBase        = "base"
	FlagCreatePullRequestAssigneeIDs = "assignee-ids"
	FlagCreatePullRequestTokenEnv    = "token-env"
	FlagCreatePullRequestDryRun      = "dry-run"
	FlagCreatePullRequestOutputFile  = "output-file"
)

Types

type CreatePullRequestOptions

type CreatePullRequestOptions struct {
	Dir   string
	Title string
	Body  string
	Head  string
	Base  string
	// OutputFile is the path to the file to write the pull request info to.
	OutputFile string
	// AssigneeIDs is the list of GitHub user IDs to assign to the pull request.
	// Each ID can be either an integer or a string.
	AssigneeIDs []string
	TokenEnv    string
	DryRun      bool
}

type PullRequest

type PullRequest struct {
	ID      int64  `json:"id" yaml:"id"`
	NodeID  string `json:"nodeID" yaml:"nodeID"`
	Number  int    `json:"number" yaml:"number"`
	Head    string `json:"head" yaml:"head"`
	HTMLURL string `json:"htmlURL" yaml:"htmlURL"`
}

PullRequest is a pull request on GitHub that is created by kargo / CreatePullRequest function.

func CreatePullRequest

func CreatePullRequest(ctx context.Context, opts CreatePullRequestOptions) (*PullRequest, error)

CreatePullRequest creates a pull request on GitHub. dir is the directory of the repository. title is the title of the pull request. body is the body of the pull request. head is the branch to merge from. base is the branch to merge to. token is the GitHub token. It returns the PullRequest object on success.

type Repository

type Repository struct {
	Owner string
	Name  string
}