Documentation ¶
Index ¶
- Constants
- func IsMetaStage(status string) bool
- func JQLStringsSimple(field string, exclude bool, vals []string, jqlMaxLength uint) []string
- func MetaStageOrder() []string
- func StatusesInactive() []string
- func TimeRemaining(status string, timeOriginalEstimate, timeEstimate, timeSpent int) (timeRemainingOriginal, timeRemaining int)
- type Config
- type EstimateStats
- type EstimateVsActual
- type IssuesStats
- type JQL
- type ProjectMeta
- type ProjectsMeta
- type StageConfig
- func (ss *StageConfig) DoneName() string
- func (ss *StageConfig) Exists(stageName string) bool
- func (ss *StageConfig) InDeploymentName() string
- func (ss *StageConfig) InDesignName() string
- func (ss *StageConfig) InDevelopmentName() string
- func (ss *StageConfig) InPlanningName() string
- func (ss *StageConfig) InReviewName() string
- func (ss *StageConfig) InTestingName() string
- func (ss *StageConfig) Map() map[string]uint
- func (ss *StageConfig) Order() []string
- func (ss *StageConfig) ReadyForDeploymentName() string
- func (ss *StageConfig) ReadyForDesignName() string
- func (ss *StageConfig) ReadyForDevlopmentName() string
- func (ss *StageConfig) ReadyForReviewName() string
- func (ss *StageConfig) ReadyForTestingName() string
- func (ss *StageConfig) ReadyforPlanningName() string
- func (ss *StageConfig) TrimSpaceNames()
- type StatusConfig
- func (ss *StatusConfig) Add(status, metaStage string) error
- func (ss *StatusConfig) AddMapSlice(m map[string][]string) error
- func (ss *StatusConfig) MapMetaStageToStatuses() map[string][]string
- func (ss *StatusConfig) MetaStage(status string) string
- func (ss *StatusConfig) StatusesDone() []string
- func (ss *StatusConfig) StatusesForMetaStage(metaStatus string) []string
- func (ss *StatusConfig) StatusesInDevelopment() []string
- func (ss *StatusConfig) StatusesInDevelopmentAndDone() []string
- func (ss *StatusConfig) StatusesReadyForPlanning() []string
- type TimeStats
- type TimeStatsSet
- type TimeStatsSets
Constants ¶
View Source
const ( FieldFilter = "filter" FieldIssue = "issue" // issue keys FieldKey = "key" FieldParent = "parent" FieldProject = "project" // project keys FieldStatus = "status" FieldType = "type" FieldIssuePlural = "issues" // Statuses: https://support.atlassian.com/jira-cloud-administration/docs/what-are-issue-statuses-priorities-and-resolutions/ StatusOpen = "Open" StatusInProgress = "In Progress" StatusDone = "Done" StatusToDo = "To Do" StatusInReview = "In Review" StatusUnderReview = "Under review" StatusApproved = "Approved" // Done TypeIssue = "Issue" TypeIssuePlural = "Issues" TypeBug = "Bug" TypeBugPlural = "Bugs" TypeEpic = "Epic" TypeEpicPlural = "Epics" TypeSpike = "Spike" TypeSpikePlural = "Spikes" TypeStory = "Story" TypeStoryPlural = "Stories" TypeInitiative = "Initiative" TypeInitiativePlura = "Initiatives" StagePlanning = "Planning" StageDesign = "Design" StageDevelopment = "Development" StageTesting = "Testing" StageDeployment = "Deployment" StageReview = "Review" MetaStagePrefixReadyFor = "Ready for " MetaStagePrefixIn = "In " MetaStageReadyForPlanning = MetaStagePrefixReadyFor + StagePlanning MetaStageInPlanning = MetaStagePrefixIn + StagePlanning MetaStageReadyForDesign = MetaStagePrefixReadyFor + StageDesign MetaStageInDesign = MetaStagePrefixIn + StageDesign MetaStageReadyForDevelopment = MetaStagePrefixReadyFor + StageDevelopment MetaStageInDevelopment = MetaStagePrefixIn + StageDevelopment MetaStageReadyForTesting = MetaStagePrefixReadyFor + StageTesting MetaStageInTesting = MetaStagePrefixIn + StageTesting MetaStageReadyForDeployment = MetaStagePrefixReadyFor + StageDeployment MetaStageInDeployment = MetaStagePrefixIn + StageDeployment MetaStageReadyForReview = MetaStagePrefixReadyFor + StageReview MetaStageInReview = MetaStagePrefixIn + StageReview MetaStageDone = StatusDone WorkingHoursPerDayDefault float32 = 8.0 WorkingDaysPerWeekDefault float32 = 5.0 JiraXMLGenerated = time.UnixDate // "Fri Jul 28 01:07:16 UTC 2023" JQLMaxResults = 100 JQLMaxLength = 6000 // https://jira.atlassian.com/browse/JRASERVER-41005 JQLInSep = "," )
Variables ¶
This section is empty.
Functions ¶
func IsMetaStage ¶ added in v0.14.0
func JQLStringsSimple ¶ added in v0.10.0
JQLStringsSimple provides a set of JQLs for a single field and values. The purpose of this function is to split very long lists of values so that each JQL is under a certain length limit.
func MetaStageOrder ¶ added in v0.14.0
func MetaStageOrder() []string
func StatusesInactive ¶ added in v0.10.0
func StatusesInactive() []string
func TimeRemaining ¶
func TimeRemaining(status string, timeOriginalEstimate, timeEstimate, timeSpent int) (timeRemainingOriginal, timeRemaining int)
TimeRemaining returns calculated timeRemainingOriginal and timeRemaiing and against the timeOriginalEstimate and timeEstimate respectively.
Types ¶
type Config ¶
type Config struct { ServerURL string WorkingHoursPerDay float32 WorkingDaysPerWeek float32 StatusConfig *StatusConfig }
func NewConfigDefault ¶
func NewConfigDefault() *Config
func (*Config) CapacityForDaysPeople ¶
func (*Config) SecondsToDays ¶
func (*Config) SecondsToWeeks ¶ added in v0.16.0
type EstimateStats ¶
type EstimateVsActual ¶
type EstimateVsActual struct { ClosedCount int ClosedCountWithEstimate int EstimateDays float64 ActualDays float64 EstimateRatio float64 }
func (*EstimateVsActual) Inflate ¶
func (eva *EstimateVsActual) Inflate()
type IssuesStats ¶
type IssuesStats struct { WorkingHoursPerDay float32 WorkingDaysPerWeek float32 ItemCount int ItemCountByStatus map[string]int ItemCountByType map[string]int EstimateStatsByType map[string]EstimateStats TimeOriginalEstimate time.Duration TimeOriginalEstimateDays float64 AggregateTimeSpent time.Duration AggregateTimeSpentDays float64 ClosedEstimateVsActual EstimateVsActual }
type JQL ¶ added in v0.10.0
type JQL struct { CreatedGTE time.Time FiltersIncl [][]string // outer level is `AND`, inner level is `IN`. FiltersExcl [][]string IssuesIncl [][]string IssuesExcl [][]string KeysIncl [][]string KeysExcl [][]string ParentsIncl [][]string ParentsExcl [][]string ProjectsIncl [][]string ProjectsExcl [][]string StatusesIncl [][]string StatusesExcl [][]string TypesIncl [][]string TypesExcl [][]string Raw []string }
JQL is a JQL builder. It will create a JQL string using `JQL.String()` from the supplied infomration.
type ProjectMeta ¶ added in v0.11.0
type ProjectsMeta ¶ added in v0.11.0
type ProjectsMeta struct {
Projects map[string]ProjectMeta
}
func NewProjectsMeta ¶ added in v0.11.0
func NewProjectsMeta() ProjectsMeta
func (*ProjectsMeta) AddMap ¶ added in v0.11.0
func (pm *ProjectsMeta) AddMap(info map[string]float32)
func (*ProjectsMeta) CapacitySimple ¶ added in v0.12.0
func (pm *ProjectsMeta) CapacitySimple(itemsPerWeekPerFTE, weekCount float32) float32
func (*ProjectsMeta) FTEs ¶ added in v0.12.0
func (pm *ProjectsMeta) FTEs() float32
type StageConfig ¶ added in v0.16.0
type StageConfig struct { StageNamePlanning string StageNameDesign string StageNameDevelopment string StageNameTesting string StageNameDeployment string StageNameReview string StageNameDone string MetaStageInPlanning string // Override auto-build MetaStageReadyForPlanning string MetaStageInDesign string MetaStageReadyForDesign string MetaStageInDevelopment string MetaStageReadyForDevelopment string MetaStageReadyForTesting string MetaStageInTesting string MetaStageReadyForDeployment string MetaStageInDeployment string MetaStageReadyForReview string MetaStageInReview string MetaStageDone string MetaStagePrefixIn string MetaStagePrefixReadyFor string }
func DefaultStageSet ¶ added in v0.16.0
func DefaultStageSet() *StageConfig
func NewStageConfigEmpty ¶ added in v0.16.0
func NewStageConfigEmpty() *StageConfig
func (*StageConfig) DoneName ¶ added in v0.16.0
func (ss *StageConfig) DoneName() string
func (*StageConfig) Exists ¶ added in v0.16.0
func (ss *StageConfig) Exists(stageName string) bool
func (*StageConfig) InDeploymentName ¶ added in v0.16.0
func (ss *StageConfig) InDeploymentName() string
func (*StageConfig) InDesignName ¶ added in v0.16.0
func (ss *StageConfig) InDesignName() string
func (*StageConfig) InDevelopmentName ¶ added in v0.16.0
func (ss *StageConfig) InDevelopmentName() string
func (*StageConfig) InPlanningName ¶ added in v0.16.0
func (ss *StageConfig) InPlanningName() string
func (*StageConfig) InReviewName ¶ added in v0.16.0
func (ss *StageConfig) InReviewName() string
func (*StageConfig) InTestingName ¶ added in v0.16.0
func (ss *StageConfig) InTestingName() string
func (*StageConfig) Map ¶ added in v0.16.0
func (ss *StageConfig) Map() map[string]uint
func (*StageConfig) Order ¶ added in v0.16.0
func (ss *StageConfig) Order() []string
func (*StageConfig) ReadyForDeploymentName ¶ added in v0.16.0
func (ss *StageConfig) ReadyForDeploymentName() string
func (*StageConfig) ReadyForDesignName ¶ added in v0.16.0
func (ss *StageConfig) ReadyForDesignName() string
func (*StageConfig) ReadyForDevlopmentName ¶ added in v0.16.0
func (ss *StageConfig) ReadyForDevlopmentName() string
func (*StageConfig) ReadyForReviewName ¶ added in v0.16.0
func (ss *StageConfig) ReadyForReviewName() string
func (*StageConfig) ReadyForTestingName ¶ added in v0.16.0
func (ss *StageConfig) ReadyForTestingName() string
func (*StageConfig) ReadyforPlanningName ¶ added in v0.16.0
func (ss *StageConfig) ReadyforPlanningName() string
func (*StageConfig) TrimSpaceNames ¶ added in v0.16.0
func (ss *StageConfig) TrimSpaceNames()
type StatusConfig ¶ added in v0.16.0
type StatusConfig struct { Map map[string]string StageConfig StageConfig }
func NewStatusConfig ¶ added in v0.16.0
func NewStatusConfig(stageConfig StageConfig) StatusConfig
func (*StatusConfig) Add ¶ added in v0.16.0
func (ss *StatusConfig) Add(status, metaStage string) error
func (*StatusConfig) AddMapSlice ¶ added in v0.16.0
func (ss *StatusConfig) AddMapSlice(m map[string][]string) error
AddMapSlice should be a map where the keys are meta statuses and the values are slices of Jira statuses.
func (*StatusConfig) MapMetaStageToStatuses ¶ added in v0.16.0
func (ss *StatusConfig) MapMetaStageToStatuses() map[string][]string
func (*StatusConfig) MetaStage ¶ added in v0.16.0
func (ss *StatusConfig) MetaStage(status string) string
MetaStage returns the metastatus for a status. If there is no metastatus, an empty string is returned.
func (*StatusConfig) StatusesDone ¶ added in v0.16.0
func (ss *StatusConfig) StatusesDone() []string
func (*StatusConfig) StatusesForMetaStage ¶ added in v0.16.0
func (ss *StatusConfig) StatusesForMetaStage(metaStatus string) []string
func (*StatusConfig) StatusesInDevelopment ¶ added in v0.16.0
func (ss *StatusConfig) StatusesInDevelopment() []string
func (*StatusConfig) StatusesInDevelopmentAndDone ¶ added in v0.16.0
func (ss *StatusConfig) StatusesInDevelopmentAndDone() []string
func (*StatusConfig) StatusesReadyForPlanning ¶ added in v0.16.0
func (ss *StatusConfig) StatusesReadyForPlanning() []string
type TimeStats ¶
type TimeStats struct { TimeUnit string WorkingHoursPerDay float32 WorkingDaysPerWeek float32 ItemCount int TimeSpent float32 TimeEstimate float32 TimeOriginalEstimate float32 AggregateTimeOriginalEstimate float32 AggregateTimeSpent float32 AggregateTimeEstimate float32 TimeRemaining float32 TimeRemainingOriginal float32 }
func (TimeStats) SecondsToDays ¶
type TimeStatsSet ¶
type TimeStatsSets ¶
type TimeStatsSets struct {
Map map[string]TimeStatsSet
}
func (*TimeStatsSets) AddIssue ¶
func (tss *TimeStatsSets) AddIssue(iss jira.Issue)
Source Files ¶
Click to show internal directories.
Click to hide internal directories.