Documentation
¶
Overview ¶
Package jira contains a small Jira Cloud API client tailored to jiratui's workflow.
Index ¶
- func IsSameLocalDay(t time.Time, day time.Time, loc *time.Location) bool
- func StatusCategoryForName(status string) string
- type Board
- type BoardConfiguration
- type Client
- func (c *Client) ActiveSprint(ctx context.Context, boardID int) (Sprint, error)
- func (c *Client) AddIssuesToSprint(ctx context.Context, sprintID int, issueKeys []string) error
- func (c *Client) AssignIssue(ctx context.Context, issueKey string, accountID string) error
- func (c *Client) BoardConfiguration(ctx context.Context, boardID int) (BoardConfiguration, error)
- func (c *Client) CreateTask(ctx context.Context, input CreateTaskInput) (Issue, error)
- func (c *Client) DeleteTask(ctx context.Context, issueKey string) error
- func (c *Client) Fields(ctx context.Context) ([]Field, error)
- func (c *Client) IssueStatusChanges(ctx context.Context, issue Issue) ([]StatusChange, error)
- func (c *Client) Myself(ctx context.Context) (User, error)
- func (c *Client) Project(ctx context.Context, projectKeyOrID string) (Project, error)
- func (c *Client) ProjectIssueTypes(ctx context.Context, projectID string) ([]IssueType, error)
- func (c *Client) SearchBoards(ctx context.Context, projectKeyOrID string) ([]Board, error)
- func (c *Client) SearchMySprintIssues(ctx context.Context, projectKey string, sprintID int, ...) ([]Issue, error)
- func (c *Client) SearchProjects(ctx context.Context, query string) ([]Project, error)
- func (c *Client) SearchUpdatedIssues(ctx context.Context, projectKey string, sprintID int, since time.Time, ...) ([]Issue, error)
- func (c *Client) TransitionIssue(ctx context.Context, issueKey, transitionID string) error
- func (c *Client) Transitions(ctx context.Context, issueKey string) ([]Transition, error)
- func (c *Client) UpdateStoryPoints(ctx context.Context, issueKey, storyPointsFieldID string, points *float64) error
- func (c *Client) UpdateTask(ctx context.Context, issueKey, summary, description string) error
- type CreateTaskInput
- type Field
- type Issue
- type IssueType
- type Project
- type Sprint
- type Status
- type StatusCategory
- type StatusChange
- type Transition
- type User
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsSameLocalDay ¶
IsSameLocalDay reports whether t falls on day in loc.
func StatusCategoryForName ¶
StatusCategoryForName maps common Jira status names to a report bucket.
Types ¶
type BoardConfiguration ¶
BoardConfiguration contains agile board metadata needed by setup discovery.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a Jira Cloud REST API client.
func (*Client) ActiveSprint ¶
ActiveSprint returns the active sprint for a Scrum board.
func (*Client) AddIssuesToSprint ¶
AddIssuesToSprint adds issues to a Jira sprint.
func (*Client) AssignIssue ¶
AssignIssue assigns an issue to a Jira Cloud account.
func (*Client) BoardConfiguration ¶
BoardConfiguration returns agile board settings such as the estimation field.
func (*Client) CreateTask ¶
CreateTask creates a Jira Task. Add it to a sprint with AddIssuesToSprint afterwards.
func (*Client) DeleteTask ¶ added in v0.3.0
DeleteTask permanently deletes an issue.
func (*Client) IssueStatusChanges ¶
IssueStatusChanges returns status changes for an issue from Jira changelog.
func (*Client) ProjectIssueTypes ¶
ProjectIssueTypes returns issue types available to a project.
func (*Client) SearchBoards ¶
SearchBoards returns agile boards for a project key or id.
func (*Client) SearchMySprintIssues ¶
func (c *Client) SearchMySprintIssues(ctx context.Context, projectKey string, sprintID int, storyPointsFieldID string) ([]Issue, error)
SearchMySprintIssues returns issues assigned to the current user in a sprint.
func (*Client) SearchProjects ¶
SearchProjects returns Jira projects matching query.
func (*Client) SearchUpdatedIssues ¶
func (c *Client) SearchUpdatedIssues(ctx context.Context, projectKey string, sprintID int, since time.Time, storyPointsFieldID string) ([]Issue, error)
SearchUpdatedIssues returns sprint issues updated since the given time.
func (*Client) TransitionIssue ¶
TransitionIssue applies a Jira workflow transition.
func (*Client) Transitions ¶
Transitions returns all valid workflow transitions for an issue.
type CreateTaskInput ¶
type CreateTaskInput struct {
ProjectKey string
IssueTypeID string
AssigneeID string
Summary string
Description string
StoryPoints *float64
StoryPointsID string
AdditionalField map[string]any
}
CreateTaskInput is the payload for creating a Task in the active sprint.
type Issue ¶
type Issue struct {
ID string
Key string
Summary string
Description string
Status Status
IssueType IssueType
Assignee *User
StoryPoints *float64
Updated time.Time
}
Issue is the minimal issue shape used by jiratui.
type Status ¶
type Status struct {
ID string
Name string
Category StatusCategory
}
Status is a Jira issue status.
type StatusCategory ¶
StatusCategory is Jira's status category.
type StatusChange ¶
type StatusChange struct {
IssueKey string
IssueSummary string
FromStatus string
ToStatus string
ToCategory string
AuthorID string
At time.Time
}
StatusChange is a status transition extracted from an issue changelog.
type Transition ¶
Transition is a valid Jira workflow transition for an issue.