forge

type Account struct {
	URL   string `json:"url" title:"Address" rig:"required" desc:"https://your-org.atlassian.net"`
	User  string `json:"user" title:"Email or user" desc:"Cloud: the account email; empty for a Server personal token"`
	Token string `json:"token" title:"API token" format:"password" desc:"empty keeps the stored one"`
	Scope string `json:"scope" title:"Project or space key"`
}

type Affected func(ctx context.Context, files []string) ([]string, error)

type Client struct {
	Base string
	// Project is the repository path (group/app) for a forge, from config or the origin remote.
	Project string
	// Host is the service's web host, for links.
	Host string
	httpx.Endpoint
}

type Comment struct {
	Author string    `json:"author"`
	Time   time.Time `json:"time"`
	Body   string    `json:"body"`
}

type File struct {
	Path    string `json:"path"`
	Status  string `json:"status"`
	Patch   string `json:"-"`
	Changed int    `json:"changed"`
}

type Issue struct {
	Key      string    `json:"key"`
	Title    string    `json:"title"`
	Status   string    `json:"status"`
	Assignee string    `json:"assignee"`
	Priority string    `json:"priority"`
	Type     string    `json:"type"`
	Updated  time.Time `json:"updated"`
	URL      string    `json:"url"`
}

type IssueDetail struct {
	Key         string    `json:"key"`
	Title       string    `json:"title"`
	Status      string    `json:"status"`
	Assignee    string    `json:"assignee"`
	Description string    `json:"description"`
	Comments    []Comment `json:"comments"`
	URL         string    `json:"url"`
	// Markdown is the whole issue as one page, for a preview pane
	Markdown string `json:"markdown"`
}

type Job struct {
	ID       string        `json:"id"`
	Name     string        `json:"name"`
	Stage    string        `json:"stage"`
	Status   string        `json:"status"`
	Duration time.Duration `json:"duration"`
}

type MR struct {
	ID    string `json:"id"`
	Title string `json:"title"`
	// Issue is the tracker key (PIN-12) the title or branch names, to jump between the two
	Issue  string `json:"issue"`
	Author string `json:"author"`
	State  string `json:"state"`
	// Merge says whether it can merge: draft, conflicts, blocked by threads or checks
	Merge   string    `json:"merge"`
	Notes   int       `json:"notes"`
	Source  string    `json:"source"`
	Target  string    `json:"target"`
	Updated time.Time `json:"updated"`
	URL     string    `json:"url"`
}

type Pipeline struct {
	ID       string        `json:"id"`
	Ref      string        `json:"ref"`
	Status   string        `json:"status"`
	Started  time.Time     `json:"started"`
	Duration time.Duration `json:"duration"`
	URL      string        `json:"url"`
}

type Release struct {
	Tag      string    `json:"tag"`
	Name     string    `json:"name"`
	Released time.Time `json:"released"`
	URL      string    `json:"url"`
}

type SCM interface {
	// MRs lists merge requests: author "me" keeps those you opened, "review" those you review; query matches title and branch.
	MRs(ctx context.Context, state, author, query string) ([]MR, error)
	// MR is one merge request as a page: description, approvals, discussions and the files it changes.
	MR(ctx context.Context, mr string) (string, error)
	Rebase(ctx context.Context, mr string) error
	Files(ctx context.Context, mr string) ([]File, error)
	Approve(ctx context.Context, mr string) error
	Merge(ctx context.Context, mr string) error
	Comment(ctx context.Context, mr, body string) error
	// Open opens a merge request from source into target (the default branch when empty).
	Open(ctx context.Context, source, target, title, body string) (*MR, error)
	Pipelines(ctx context.Context, ref string, limit int) ([]Pipeline, error)
	Jobs(ctx context.Context, pipeline string) ([]Job, error)
	// Log is a job's output so far and whether the job has finished.
	Log(ctx context.Context, job string) ([]string, bool, error)
	Retry(ctx context.Context, job string) error
	// Releases is the latest ones, or those whose tag or name match query across all of them.
	Releases(ctx context.Context, query string) ([]Release, error)
	Issues(ctx context.Context, query, assignee string) ([]Issue, error)
	Issue(ctx context.Context, key string) (*IssueDetail, error)
	Transition(ctx context.Context, key, status string) error
	IssueComment(ctx context.Context, key, body string) error
}