Documentation
¶
Index ¶
- func CreateIssue(login *auth.Login, repoOwner, repoName string, opts kmup.CreateIssueOption) error
- func CreateMilestone(login *auth.Login, repoOwner, repoName, title, description string, ...) error
- func CreatePull(ctx *context.KmupContext, base, head string, allowMaintainerEdits *bool, ...) (err error)
- func CreatePullReview(ctx *context.KmupContext, idx int64, status kmup.ReviewStateType, ...) error
- func EditIssue(ctx *context.KmupContext, client *kmup.Client, opts EditIssueOption) (*kmup.Issue, error)
- func GetDefaultPRBase(login *auth.Login, owner, repo string) (string, error)
- func GetDefaultPRHead(localRepo *local_git.KmdoRepo) (owner, branch string, err error)
- func GetDefaultPRTitle(header string) string
- func GetHeadSpec(owner, branch, baseOwner string) string
- func LabelsExport(labels []*kmup.Label, path string) error
- func OpenFileInEditor(filename string) error
- func ParseDiffComments(diffFile string) ([]kmup.CreatePullReviewComment, error)
- func PullCheckout(login *auth.Login, repoOwner, repoName string, forceCreateBranch bool, ...) error
- func PullClean(login *auth.Login, repoOwner, repoName string, index int64, ignoreSHA bool, ...) error
- func PullMerge(login *auth.Login, repoOwner, repoName string, index int64, ...) error
- func RepoClone(path string, login *auth.Login, repoOwner, repoName string, ...) (*local_git.KmdoRepo, error)
- func ResolveLabelNames(client *kmup.Client, owner, repo string, labelNames []string) ([]int64, error)
- func SavePullDiff(ctx *context.KmupContext, idx int64) (string, error)
- type EditIssueOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateIssue ¶
CreateIssue creates an issue in the given repo and prints the result
func CreateMilestone ¶
func CreateMilestone(login *auth.Login, repoOwner, repoName, title, description string, deadline *time.Time, state kmup.StateType) error
CreateMilestone creates a milestone in the given repo and prints the result
func CreatePull ¶
func CreatePull(ctx *context.KmupContext, base, head string, allowMaintainerEdits *bool, opts *kmup.CreateIssueOption) (err error)
CreatePull creates a PR in the given repo and prints the result
func CreatePullReview ¶
func CreatePullReview(ctx *context.KmupContext, idx int64, status kmup.ReviewStateType, comment string, codeComments []kmup.CreatePullReviewComment) error
CreatePullReview submits a review for a PR
func EditIssue ¶
func EditIssue(ctx *context.KmupContext, client *kmup.Client, opts EditIssueOption) (*kmup.Issue, error)
EditIssue edits an issue and returns the updated issue.
func GetDefaultPRBase ¶
GetDefaultPRBase retrieves the default base branch for the given repo
func GetDefaultPRHead ¶
GetDefaultPRHead uses the currently checked out branch, tries to find a remote that has a branch with the same name, and extracts the owner from its URL. If no remote matches, owner is empty, meaning same as head repo owner.
func GetDefaultPRTitle ¶
GetDefaultPRTitle transforms a string like a branchname to a readable text
func GetHeadSpec ¶
GetHeadSpec creates a head string as expected by kmup API
func LabelsExport ¶
LabelsExport save list of labels to disc
func OpenFileInEditor ¶
OpenFileInEditor opens filename in a text editor, and blocks until the editor terminates.
func ParseDiffComments ¶
func ParseDiffComments(diffFile string) ([]kmup.CreatePullReviewComment, error)
ParseDiffComments reads a diff, extracts comments from it & returns them in a kmup compatible struct
func PullCheckout ¶
func PullCheckout( login *auth.Login, repoOwner, repoName string, forceCreateBranch bool, index int64, callback func(string) (string, error), ) error
PullCheckout checkout current workdir to the head branch of specified pull request
func PullClean ¶
func PullClean(login *auth.Login, repoOwner, repoName string, index int64, ignoreSHA bool, callback func(string) (string, error)) error
PullClean deletes local & remote feature-branches for a closed pull
func PullMerge ¶
func PullMerge(login *auth.Login, repoOwner, repoName string, index int64, opt kmup.MergePullRequestOption) error
PullMerge merges a PR
func RepoClone ¶
func RepoClone( path string, login *auth.Login, repoOwner, repoName string, callback func(string) (string, error), depth int, ) (*local_git.KmdoRepo, error)
RepoClone creates a local git clone in the given path, and sets up upstream remote for fork repos, for good usability with kmdo.
func ResolveLabelNames ¶
func ResolveLabelNames(client *kmup.Client, owner, repo string, labelNames []string) ([]int64, error)
ResolveLabelNames returns a list of label IDs for a given list of label names
func SavePullDiff ¶
func SavePullDiff(ctx *context.KmupContext, idx int64) (string, error)
SavePullDiff fetches the diff of a pull request and stores it as a temporary file. The path to the file is returned.
Source Files