api

Documentation

Index

• type Commenter
• type ExecCommentParams
• type ExecController
  • func (ctrl ExecController) Exec(ctx context.Context, opts option.ExecOptions) error
• type Executor
• type Expr
• type PostController
  • func (ctrl PostController) Post(ctx context.Context, opts option.PostOptions) error
• type PostTemplateParams
• type Reader
• type Renderer

Types

type Commenter

type Commenter interface {
	Create(ctx context.Context, cmt comment.Comment) error
}

Commenter is API to post a comment to GitHub

type ExecCommentParams

type ExecCommentParams struct {
	Stdout         string
	Stderr         string
	CombinedOutput string
	Command        string
	ExitCode       int
	Env            func(string) string
	// PRNumber is the pull request number where the comment is posted
	PRNumber int
	// Org is the GitHub Organization or User name
	Org string
	// Repo is the GitHub Repository name
	Repo string
	// SHA1 is the commit SHA1
	SHA1        string
	TemplateKey string
	Template    string
	Vars        map[string]interface{}
}

type ExecController

type ExecController struct {
	Wd        string
	Stdin     io.Reader
	Stdout    io.Writer
	Stderr    io.Writer
	Getenv    func(string) string
	Reader    Reader
	Commenter Commenter
	Renderer  Renderer
	Executor  Executor
	Expr      Expr
}

func (ExecController) Exec

func (ctrl ExecController) Exec(ctx context.Context, opts option.ExecOptions) error

type Executor

type Executor interface {
	Run(ctx context.Context, params execute.Params) (execute.Result, error)
}

type Expr

type Expr interface {
	Match(expression string, params interface{}) (bool, error)
}

type PostController

type PostController struct {
	// Wd is a path to the working directory
	Wd string
	// Getenv returns the environment variable. os.Getenv
	Getenv func(string) string
	// HasStdin returns true if there is the standard input
	// If thre is the standard input, it is treated as the comment template
	HasStdin  func() bool
	Stdin     io.Reader
	Reader    Reader
	Commenter Commenter
	Renderer  Renderer
}

func (PostController) Post

func (ctrl PostController) Post(ctx context.Context, opts option.PostOptions) error

type PostTemplateParams

type PostTemplateParams struct {
	// PRNumber is the pull request number where the comment is posted
	PRNumber int
	// Org is the GitHub Organization or User name
	Org string
	// Repo is the GitHub Repository name
	Repo string
	// SHA1 is the commit SHA1
	SHA1        string
	TemplateKey string
	Vars        map[string]interface{}
}

type Reader

type Reader interface {
	FindAndRead(cfgPath, wd string) (config.Config, error)
}

Reader is API to find and read the configuration file of github-comment

type Renderer

type Renderer interface {
	Render(tpl string, templates map[string]string, params interface{}) (string, error)
}