prworkflow

Documentation

Overview

Package prworkflow supports pull request review and follow-up workflows.

Index

• type Options
• type Report
  • func Run(ctx context.Context, opts Options) (Report, error)
• type Step

Types

type Options

type Options struct {
	Workspace string
	Message   string
	Title     string
	Body      string
	Branch    string
	Base      string
	Remote    string
	All       bool
	Draft     bool
	NoPR      bool
	DryRun    bool
}

type Report

type Report struct {
	Kind       string             `json:"kind"`
	Status     string             `json:"status"`
	DryRun     bool               `json:"dry_run"`
	Branch     string             `json:"branch"`
	Base       string             `json:"base,omitempty"`
	Remote     string             `json:"remote"`
	Title      string             `json:"title"`
	Commit     string             `json:"commit,omitempty"`
	PRURL      string             `json:"pr_url,omitempty"`
	Message    string             `json:"message,omitempty"`
	Steps      []Step             `json:"steps"`
	Ship       *ship.Report       `json:"ship,omitempty"`
	ShipEvents []laneevents.Event `json:"ship_events,omitempty"`
}

func Run

func Run(ctx context.Context, opts Options) (Report, error)

type Step

type Step struct {
	Name    string   `json:"name"`
	Command []string `json:"command,omitempty"`
	Status  string   `json:"status"`
	Output  string   `json:"output,omitempty"`
}