github

Documentation

Index

• Variables
• type Configuration
• type Github
  • func New(cfg Configuration) (*Github, error)
  • func (g *Github) CheckConfiguration() (err error)
  • func (g *Github) GetIssue(identifier string) (issue domain.Issue, err error)
  • func (g *Github) IdentifyIssue(identifier string) bool
  • func (g *Github) ParseRawIssueId(identifier string) (issueId string)
• type Issue
  • func (i Issue) Body() string
  • func (i Issue) FormatID() string
  • func (i Issue) ID() string
  • func (i Issue) Title() string
  • func (i Issue) TrackerType() domain.IssueTrackerType
  • func (i Issue) Type() issue_types.IssueType
  • func (i Issue) TypeLabel() string
  • func (i Issue) URL() string
• type Label

Variables

var ErrIdIsPullRequestNumber = func(identifier string) error {
	return fmt.Errorf("given identifier %s is a Pull Request number", identifier)
}

var ErrIssueNotFound = fmt.Errorf("the issue was not found")

Types

type Configuration

type Configuration struct {
	config.Github
}

type Github

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

func New

func New(cfg Configuration) (*Github, error)

New returns a new Github issue tracker with the given configuration

func (*Github) CheckConfiguration

func (g *Github) CheckConfiguration() (err error)

func (*Github) GetIssue

func (g *Github) GetIssue(identifier string) (issue domain.Issue, err error)

func (*Github) IdentifyIssue

func (g *Github) IdentifyIssue(identifier string) bool

func (*Github) ParseRawIssueId

func (g *Github) ParseRawIssueId(identifier string) (issueId string)

type Issue

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

func (Issue) Body

func (i Issue) Body() string

func (Issue) FormatID

func (i Issue) FormatID() string

func (Issue) ID

func (i Issue) ID() string

func (Issue) Title

func (i Issue) Title() string

func (Issue) TrackerType

func (i Issue) TrackerType() domain.IssueTrackerType

func (Issue) Type

func (i Issue) Type() issue_types.IssueType

func (Issue) TypeLabel

func (i Issue) TypeLabel() string

func (Issue) URL

func (i Issue) URL() string

type Label

type Label struct {
	Id          int
	Name        string
	Description string
	Color       string
}