jiracommon

Documentation

Index

• func GetWorkConfig(qc jiracommonapi.QueryContext) (res rpcdef.OnboardExportResult, _ error)
• type Config
• type CustomFieldIDs
• type JiraCommon
  • func New(opts Opts) (*JiraCommon, error)
  • func (s *JiraCommon) CommonQC() jiracommonapi.QueryContext
  • func (s *JiraCommon) ExportDone() error
  • func (s *JiraCommon) IssuePriorities(sender *objsender.Session) error
  • func (s *JiraCommon) IssueTypes(sender *objsender.Session) error
  • func (s *JiraCommon) IssuesAndChangelogs(projectSender *objsender.Session, projects []Project, ...) (_ []rpcdef.ExportProject, rerr error)
  • func (s *JiraCommon) Mutate(ctx context.Context, fn, data string, config rpcdef.ExportConfig) (res rpcdef.MutateResult, _ error)
  • func (s *JiraCommon) ProcessAllProjectsUsingExclusions(projectSender *objsender.Session, allProjectsDetailed []*work.Project) (notExcluded []Project, rerr error)
  • func (s *JiraCommon) SetupUsers() error
• type Model
• type Opts
• type Project
  • func (s Project) GetID() string
  • func (s Project) GetReadableID() string
• type Sprint
• type SprintWithIssues
• type Sprints
  • func NewSprints() *Sprints
  • func (s *Sprints) SprintsWithIssues() (res []SprintWithIssues)
• type Users
  • func NewUsers(logger hclog.Logger, customerID string, agent rpcdef.Agent, websiteURL string) (_ *Users, rerr error)
  • func (s *Users) Done() error
  • func (s *Users) ExportUser(user jiracommonapi.User) error

Functions

func GetWorkConfig

func GetWorkConfig(qc jiracommonapi.QueryContext) (res rpcdef.OnboardExportResult, _ error)

GetWorkConfig will return the default jira work config

Types

type Config

type Config struct {
	URL      string `json:"url"`
	Username string `json:"username"`
	Password string `json:"password"`

	Exclusions []string `json:"exclusions"`
	Inclusions []string `json:"inclusions"`
	// Projects specifies a specific projects to process. Ignores excluded_projects in this case. Specify projects using jira key. For example: DE.
	Projects []string `json:"projects"`
}

type CustomFieldIDs

type CustomFieldIDs struct {
	StoryPoints string
	Epic        string
}

type JiraCommon

type JiraCommon struct {
	// contains filtered or unexported fields
}

func New

func New(opts Opts) (*JiraCommon, error)

func (*JiraCommon) CommonQC

func (s *JiraCommon) CommonQC() jiracommonapi.QueryContext

func (*JiraCommon) ExportDone

func (s *JiraCommon) ExportDone() error

func (*JiraCommon) IssuePriorities

func (s *JiraCommon) IssuePriorities(sender *objsender.Session) error

func (*JiraCommon) IssueTypes

func (s *JiraCommon) IssueTypes(sender *objsender.Session) error

func (*JiraCommon) IssuesAndChangelogs

func (s *JiraCommon) IssuesAndChangelogs(
	projectSender *objsender.Session,
	projects []Project,
	fieldByID map[string]jiracommonapi.CustomField) (_ []rpcdef.ExportProject, rerr error)

func (*JiraCommon) Mutate

func (s *JiraCommon) Mutate(ctx context.Context, fn, data string, config rpcdef.ExportConfig) (res rpcdef.MutateResult, _ error)

func (*JiraCommon) ProcessAllProjectsUsingExclusions

func (s *JiraCommon) ProcessAllProjectsUsingExclusions(projectSender *objsender.Session, allProjectsDetailed []*work.Project) (notExcluded []Project, rerr error)

func (*JiraCommon) SetupUsers

func (s *JiraCommon) SetupUsers() error

type Model

type Model interface {
	ToMap() map[string]interface{}
}

type Opts

type Opts struct {
	WebsiteURL       string
	Logger           hclog.Logger
	CustomerID       string
	Req              jiracommonapi.Requester
	Agent            rpcdef.Agent
	ExcludedProjects []string
	IncludedProjects []string
	// Projects only process these projects by key.
	Projects    []string
	IsOnPremise bool
}

type Project

type Project struct {
	jiracommonapi.Project
}

func (Project) GetID

func (s Project) GetID() string

func (Project) GetReadableID

func (s Project) GetReadableID() string

type Sprint

type Sprint struct {
	ID            int
	Name          string
	Goal          string
	State         string
	StartDate     time.Time
	EndDate       time.Time
	CompleteDate  time.Time
	OriginBoardID int
}

type SprintWithIssues

type SprintWithIssues struct {
	Sprint
	Issues []string
}

type Sprints

type Sprints struct {
	// contains filtered or unexported fields
}

func NewSprints

func NewSprints() *Sprints

func (*Sprints) SprintsWithIssues

func (s *Sprints) SprintsWithIssues() (res []SprintWithIssues)

type Users

type Users struct {
	// contains filtered or unexported fields
}

func NewUsers

func NewUsers(logger hclog.Logger, customerID string, agent rpcdef.Agent, websiteURL string) (_ *Users, rerr error)

func (*Users) Done

func (s *Users) Done() error

func (*Users) ExportUser

func (s *Users) ExportUser(user jiracommonapi.User) error

Export user is safe for concurrent use