Documentation
¶
Overview ¶
Package sprints provides sprint commands for GitScrum CLI
Index ¶
- func NewCmdSprints(f *factory.Factory) *cobra.Command
- func NewCmdSprintsBurndown(f *factory.Factory) *cobra.Command
- func NewCmdSprintsCreate(f *factory.Factory) *cobra.Command
- func NewCmdSprintsCurrent(f *factory.Factory) *cobra.Command
- func NewCmdSprintsStats(f *factory.Factory) *cobra.Command
- func NewCmdSprintsView(f *factory.Factory) *cobra.Command
- type DateResource
- type Sprint
- type SprintDetail
- type SprintStats
- type SprintStatus
- type SprintTask
- type SprintTimeboxDetail
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewCmdSprints ¶
NewCmdSprints creates the sprints command group
func NewCmdSprintsBurndown ¶
NewCmdSprintsBurndown shows burndown chart
func NewCmdSprintsCreate ¶
NewCmdSprintsCreate creates a new sprint
func NewCmdSprintsCurrent ¶
NewCmdSprintsCurrent shows the active sprint
func NewCmdSprintsStats ¶
NewCmdSprintsStats shows sprint statistics
Types ¶
type DateResource ¶
type DateResource struct {
DateForHumans string `json:"date_for_humans"`
ISO8601 string `json:"iso8601"`
Timestamp int64 `json:"timestamp"`
}
DateResource represents a date from the API
type Sprint ¶
type Sprint struct {
ID int `json:"id"`
Code string `json:"code"`
Slug string `json:"slug"`
Title string `json:"title"`
Timebox string `json:"timebox"`
Duration int `json:"duration"`
Status SprintStatus `json:"status"`
Stats SprintStats `json:"stats"`
}
Sprint represents a sprint for list endpoints (timebox is a string)
type SprintDetail ¶
type SprintDetail struct {
ID int `json:"id"`
Code string `json:"code"`
Slug string `json:"slug"`
Title string `json:"title"`
Timebox SprintTimeboxDetail `json:"timebox"`
Duration int `json:"duration"`
Status SprintStatus `json:"status"`
Stats SprintStats `json:"stats"`
}
SprintDetail represents a single sprint from detail endpoint (timebox is an object)
type SprintStats ¶
type SprintStats struct {
WorkedHours interface{} `json:"worked_hours"`
TotalTasks interface{} `json:"total_tasks"`
ClosedTasks interface{} `json:"closed_tasks"`
Percentage interface{} `json:"percentage"`
StoryPoints interface{} `json:"story_points"`
Comments interface{} `json:"comments"`
}
SprintStats represents sprint statistics (using interface{} for flexible types)
type SprintStatus ¶
type SprintStatus struct {
Slug string `json:"slug"`
Title string `json:"title"`
Description string `json:"description"`
Color string `json:"color"`
}
SprintStatus represents a sprint status from the API
type SprintTask ¶
type SprintTask struct {
Code string `json:"code"`
RefCode string `json:"ref_code"`
Slug string `json:"slug"`
Title string `json:"title"`
Effort interface{} `json:"effort"`
Priority interface{} `json:"priority"`
Workflow struct {
Title string `json:"title"`
State int `json:"state"`
} `json:"workflow"`
Users []struct {
Username string `json:"username"`
} `json:"users"`
}
SprintTask represents a task in a sprint
func (SprintTask) GetIdentifier ¶
func (t SprintTask) GetIdentifier() string
GetIdentifier returns the best identifier for CLI/API usage Priority: ref_code (always 8 chars) > code > slug
type SprintTimeboxDetail ¶
type SprintTimeboxDetail struct {
Start *DateResource `json:"start"`
Finish *DateResource `json:"finish"`
}
SprintTimeboxDetail represents the timebox object from detail API (contains DateResource objects)
func (SprintTimeboxDetail) String ¶
func (t SprintTimeboxDetail) String() string
String returns a formatted period string
Source Files