comment

Documentation

Index

• Constants
• Variables
• type Comment
• type Comments
  • func (cs Comments) FindComment(login string, commentType model.IssueCommentType) (model.IssueComment, bool)
• type EligibleComment
  • func NewEligibleComment(issue model.Issue, pullRequest *string) EligibleComment
  • func (c EligibleComment) String() (string, error)
  • func (c EligibleComment) Type() model.IssueCommentType
• type ErrorRewardComment
  • func NewErrorRewardComment(err error) ErrorRewardComment
  • func (c ErrorRewardComment) String() (string, error)
  • func (c ErrorRewardComment) Type() model.IssueCommentType
• type RewardComment
  • func NewRewardComment(contributors []*model2.Contributor, currency, owner, repoName string) RewardComment
  • func (c RewardComment) String() (string, error)
  • func (c RewardComment) Type() model.IssueCommentType

Constants

const (
	EligibleCommentHeaderLegacy    = "🤖 Assignees for Issue"
	EligibleCommentHeaderBeginning = "🤖 Assignees for issue"
)

const ErrorRewardCommentHeader = "### Famed could not generate a reward suggestion."

const RewardCommentTableHeader = "| Contributor | Time | Reward |\n| ----------- | ----------- | ----------- |"

Variables

var ErrNoContributors = errors.New("GitHub data incomplete")

Types

type Comment

type Comment interface {
	String() (string, error)
	Type() model.IssueCommentType
}

type Comments

type Comments []model.IssueComment

func (Comments) FindComment

func (cs Comments) FindComment(login string, commentType model.IssueCommentType) (model.IssueComment, bool)

FindComment finds the first comment where the matching commentType posted by the user with a login equal to botLogin.

type EligibleComment

type EligibleComment struct {
	// contains filtered or unexported fields
}

func NewEligibleComment

func NewEligibleComment(issue model.Issue, pullRequest *string) EligibleComment

NewEligibleComment generate an issue eligible comment.

func (EligibleComment) String

func (c EligibleComment) String() (string, error)

func (EligibleComment) Type

func (c EligibleComment) Type() model.IssueCommentType

type ErrorRewardComment

type ErrorRewardComment struct {
	// contains filtered or unexported fields
}

func NewErrorRewardComment

func NewErrorRewardComment(err error) ErrorRewardComment

NewErrorRewardComment return a ErrorRewardComment.

func (ErrorRewardComment) String

func (c ErrorRewardComment) String() (string, error)

func (ErrorRewardComment) Type

func (c ErrorRewardComment) Type() model.IssueCommentType

type RewardComment

type RewardComment struct {
	// contains filtered or unexported fields
}

func NewRewardComment

func NewRewardComment(contributors []*model2.Contributor, currency, owner, repoName string) RewardComment

NewRewardComment return a RewardComment.

func (RewardComment) String

func (c RewardComment) String() (string, error)

func (RewardComment) Type

func (c RewardComment) Type() model.IssueCommentType