commenter

Documentation

Index

• type Commenter
  • func NewCommenter(cfg Config, deps Dependencies) *Commenter
  • func (c *Commenter) AddComment(ctx context.Context, owner string, repo string, number int, comment string) error
• type Config
• type Dependencies
• type PullRequestsService

Types

type Commenter

type Commenter struct {
	Config
	Dependencies
	Client *github.IssuesService
}

Commenter is a github based commenter.

func NewCommenter

func NewCommenter(cfg Config, deps Dependencies) *Commenter

NewCommenter creates a new Commenter

func (*Commenter) AddComment

func (c *Commenter) AddComment(ctx context.Context, owner string, repo string, number int, comment string) error

AddComment adds a comment to a PR to show progress of the bot.

type Config

type Config struct {
	Auth auth.Config
}

Config has the configuration options for the commenter

type Dependencies

type Dependencies struct {
	Logger    zerolog.Logger
	Converter providers.EnvironmentConverter
}

Dependencies defines the dependencies of this commenter

type PullRequestsService

type PullRequestsService interface {
	CreateComment(ctx context.Context, owner string, repo string, number int, comment *github.IssueComment) (*github.IssueComment, *github.Response, error)
}

PullRequestsService is an interface defining the Wrapper Interface needed to test the github client.