github

Documentation

Index

• Constants
• Variables
• func NewModule() loader.Module
• type GlobalConfig
  • func (global *GlobalConfig) PromptUserForConfig() error
• type LocalConfig
  • func (local *LocalConfig) PromptUserForConfig() error

Constants

const (
	DefaultApprovedLabel         = "approved"
	DefaultBeingImplementedLabel = "being implemented"
	DefaultImplementedLabel      = "implemented"
	DefaultReviewedLabel         = "reviewed"
	DefaultSkipReviewLabel       = "no review"
	DefaultPassedTestingLabel    = "qa+"
	DefaultFailedTestingLabel    = "qa-"
	DefaultSkipTestingLabel      = "no qa"
	DefaultStagedLabel           = "staged"
	DefaultRejectedLabel         = "rejected"
)

const (
	ModuleId   = "salsaflow.modules.issuetracking.github"
	ModuleKind = loader.ModuleKindIssueTracking
)

const MaxConcurrentRequests = 10

const ServiceName = "GitHub Issues"

Variables

var DefaultStoryLabels = []string{"enhancement", "bug"}

var ImplicitSkipCheckLabels = []string{"duplicate", "invalid"}

Functions

func NewModule

func NewModule() loader.Module

Types

type GlobalConfig

type GlobalConfig struct {
	UserToken string `prompt:"GitHub token to be used when calling GitHub API" secret:"true" json:"token"`
}

GlobalConfig implements loader.ConfigContainer

func (*GlobalConfig) PromptUserForConfig

func (global *GlobalConfig) PromptUserForConfig() error

PromptUserForConfig is a part of loader.ConfigContainer

type LocalConfig

type LocalConfig struct {
	StoryLabels []string `json:"story_labels"`

	StateLabels struct {
		ApprovedLabel         string `prompt:"'approved' label" default:"approved" json:"approved"`
		BeingImplementedLabel string `prompt:"'being implemented' label" default:"being implemented" json:"being_implemented"`
		ImplementedLabel      string `prompt:"'implemented' label" default:"implemented" json:"implemented"`
		ReviewedLabel         string `prompt:"'reviewed' label" default:"reviewed" json:"reviewed"`
		SkipReviewLabel       string `prompt:"'no review' label" default:"no review" json:"skip_review"`
		PassedTestingLabel    string `prompt:"'passed testing' label" default:"qa+" json:"passed_testing"`
		FailedTestingLabel    string `prompt:"'failed testing' label" default:"qa-" json:"failed_testing"`
		SkipTestingLabel      string `prompt:"'skip testing' label" default:"no qa" json:"skip_testing"`
		StagedLabel           string `prompt:"'staged' label" default:"staged" json:"staged_for_acceptance"`
		RejectedLabel         string `prompt:"'rejected' label" default:"rejected" json:"client_rejected"`
	} `json:"state_labels"`

	SkipCheckLabels []string `json:"skip_release_check_labels"`
	// contains filtered or unexported fields
}

LocalConfig implements loader.ConfigContainer interface.

func (*LocalConfig) PromptUserForConfig

func (local *LocalConfig) PromptUserForConfig() error

PromptUserForConfig is a part of loader.ConfigContainer interface.