discussion

Documentation

Index

• Variables
• type Comment
• type Details
  • func QueryGitHub(match *match.Match, projectPath string, issueID string) (*Details, error)
  • func QueryGitLab(match *match.Match, projectPath string, issueID string) (*Details, error)
  • func (id *Details) UpdateUsername(ownUsername string)
• type Label

Variables

var ErrIssueDoesNotExist = errors.New("discussion with the given iid does not exist")

ErrIssueDoesNotExist is returned if the requested discussion does not exist.

Types

type Comment

type Comment struct {
	Author       remote.User
	Body         string
	CreatedAt    time.Time
	UpdatedAt    time.Time
	LastEditedBy remote.User
	Comments     []Comment
	Resolved     bool
}

Comment contains the comments on an issue. Comments has a max depth of one.

type Details

type Details struct {
	Title       string
	Description string
	CreatedAt   time.Time
	UpdatedAt   time.Time
	Author      remote.User
	BaseURL     url.URL
	Assignees   []remote.User
	Labels      []Label
	Discussion  []Comment
}

Details contains the discussion of an issue.

func QueryGitHub

func QueryGitHub(match *match.Match, projectPath string, issueID string) (*Details, error)

QueryGitHub returns the discussion associated with the passed issueID. If the requested issue does not exist, an ErrIssueDoesNotExist is returned.

func QueryGitLab

func QueryGitLab(match *match.Match, projectPath string, issueID string) (*Details, error)

QueryGitLab returns the discussion associated with the passed issueID. If the requested issue does not exist, an ErrIssueDoesNotExist is returned.

func (*Details) UpdateUsername

func (id *Details) UpdateUsername(ownUsername string)

UpdateUsername replaces the username of the user with "you".

type Label

type Label struct {
	Title string
	Color string
}

Label contains the title and color of a GitLab/GitHub label.