common

Documentation

Index

• type IssueTracker
• type Story

Types

type IssueTracker

type IssueTracker interface {

	// FindStoryByTag can be used to find a story by its tag.
	FindStoryByTag(storyTag string) (Story, error)
}

IssueTracker is a common interface that must be implemented by all modules representing an issue tracker.

type Story

type Story interface {

	// OnReviewRequestOpened is called to handle the RR opened event.
	OnReviewRequestOpened(rrID, rrURL string) error

	// OnReviewRequestClosed is called to handle the RR closed event.
	OnReviewRequestClosed(rrID, rrURL string) error

	// OnReviewRequestReopened is called to handle the RR reopened event.
	OnReviewRequestReopened(rrID, rrURL string) error

	// MarkAsReviewed can be used to mark the story as reviewed when
	// that information cannot be deduced from other events.
	MarkAsReviewed() error
}

Story represents a common interface for issue tracker stories. This is where the event handling occurs.