Documentation
¶
Overview ¶
Package issue provides the "jira issue" command group for issue management.
Index ¶
- func NewCmdAssign(f *factory.Factory) *cobra.Command
- func NewCmdCreate(f *factory.Factory) *cobra.Command
- func NewCmdDelete(f *factory.Factory) *cobra.Command
- func NewCmdEdit(f *factory.Factory) *cobra.Command
- func NewCmdExport(f *factory.Factory) *cobra.Command
- func NewCmdImport(f *factory.Factory) *cobra.Command
- func NewCmdIssue(f *factory.Factory) *cobra.Command
- func NewCmdList(f *factory.Factory) *cobra.Command
- func NewCmdMove(f *factory.Factory) *cobra.Command
- func NewCmdPull(f *factory.Factory) *cobra.Command
- func NewCmdReconcile(f *factory.Factory) *cobra.Command
- func NewCmdTransitions(f *factory.Factory) *cobra.Command
- func NewCmdView(f *factory.Factory) *cobra.Command
- func ValidateIssueKeyOrID(input string) (string, error)
- type AssignOptions
- type CreateOptions
- type DeleteOptions
- type EditOptions
- type ExportOptions
- type ImportOptions
- type ListOptions
- type MoveOptions
- type PullOptions
- type ReconcileOptions
- type TransitionsOptions
- type ViewOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewCmdAssign ¶
NewCmdAssign creates the "issue assign" command.
func NewCmdCreate ¶
NewCmdCreate creates the "issue create" command.
func NewCmdDelete ¶
NewCmdDelete creates the "issue delete" command.
func NewCmdEdit ¶
NewCmdEdit creates the "issue edit" command.
func NewCmdExport ¶
NewCmdExport creates the "issue export" command.
func NewCmdImport ¶
NewCmdImport creates the "issue import" command.
func NewCmdIssue ¶
NewCmdIssue creates the "issue" command group. Subcommands (view, create, edit, delete, move, assign, list) are registered in their own stories.
func NewCmdList ¶
NewCmdList creates the "issue list" command.
func NewCmdMove ¶
NewCmdMove creates the "issue move" command.
func NewCmdPull ¶
NewCmdPull creates the "issue pull" command — the JIRA-first half of the sync: reconcile status and assignee from JIRA back into hub-style documents, leaving all other frontmatter and the body untouched.
func NewCmdReconcile ¶
NewCmdReconcile creates the "issue reconcile" command.
func NewCmdTransitions ¶
NewCmdTransitions creates the "issue transitions" command.
func NewCmdView ¶
NewCmdView creates the "issue view" command.
func ValidateIssueKeyOrID ¶
ValidateIssueKeyOrID delegates to shared.ValidateIssueKeyOrID. Kept for backward compatibility within the issue package.
Types ¶
type AssignOptions ¶
type AssignOptions struct {
Factory *factory.Factory
KeyOrID string // positional arg: issue key
UserArg string // positional arg: user (display name, account ID, or @me)
Unassign bool // --unassign
}
AssignOptions holds all resolved inputs for the issue assign command.
type CreateOptions ¶
type CreateOptions struct {
Factory *factory.Factory
Project string // --project (or default.project config)
Type string // --type
Summary string // --summary
Description string // --description (Markdown)
BodyFile string // --body-file (file path or "-" for stdin)
Assignee string // --assignee
Priority string // --priority
Labels []string // --labels
Parent string // --parent
Fields []string // --field (repeatable, key=value)
}
CreateOptions holds all resolved inputs for the issue create command.
type DeleteOptions ¶
type DeleteOptions struct {
Factory *factory.Factory
KeyOrID string // positional arg: issue key
Yes bool // --yes/-y confirmation flag
}
DeleteOptions holds all resolved inputs for the issue delete command.
type EditOptions ¶
type EditOptions struct {
Factory *factory.Factory
KeyOrID string // positional arg
Summary string // --summary
Description string // --description (Markdown)
BodyFile string // --body-file
Assignee string // --assignee
Priority string // --priority
Parent string // --parent (set-only; removal not supported)
Labels []string // --labels (replaces all)
AddLabels []string // --add-labels (delta add)
RemoveLabels []string // --remove-labels (delta remove)
Fields []string // --field (repeatable, key=value)
// contains filtered or unexported fields
}
EditOptions holds all resolved inputs for the issue edit command.
type ExportOptions ¶
type ExportOptions struct {
Factory *factory.Factory
Project string // --project (falls back to default.project)
JQL string // --jql (overrides --project)
OutputDir string // --output-dir (default ".")
Limit int // --limit (0 = all)
Tree bool // --tree (hierarchical layout)
NoProjectDir bool // --no-project-dir (skip project directory in output path)
Fields string // --fields (comma-separated custom field names)
}
ExportOptions holds all resolved inputs for the issue export command.
type ImportOptions ¶
type ImportOptions struct {
Factory *factory.Factory
Files []string // positional args: file paths
Dir string // --dir: import all .md files from directory
Force bool // --force: overwrite on conflict
Map string // --map: jira-sync.yaml field-map for hub-style frontmatter
}
ImportOptions holds all resolved inputs for the issue import command.
type ListOptions ¶
type ListOptions struct {
Factory *factory.Factory
Project string // --project (falls back to default.project)
Assignee string // --assignee (@me supported)
Status string // --status
Type string // --type
Label string // --label
Sprint string // --sprint (active, future, or sprint name)
JQL string // --jql (overrides all filter flags)
Sort string // --sort (field name for ORDER BY)
Order string // --order (asc/desc, default: desc)
Fields []string // --fields (controls returned/displayed fields)
Limit int // --limit
Offset int // --offset
NoPager bool // --no-pager
}
ListOptions holds all resolved inputs for the issue list command.
type MoveOptions ¶
type MoveOptions struct {
Factory *factory.Factory
KeyOrID string // positional arg: issue key
TargetStatus string // positional arg: target status name
Resolution string // --resolution (e.g., "Fixed", "Won't Fix")
Comment string // --comment (Markdown → ADF)
}
MoveOptions holds all resolved inputs for the issue move command.
type PullOptions ¶
PullOptions holds resolved inputs for the issue pull command.
type ReconcileOptions ¶
type ReconcileOptions struct {
Factory *factory.Factory
Dir string // --dir: markdown directory
Epic string // --epic: scope to children of this epic
Project string // --project: scope to all issues in project
JQL string // --jql: raw JQL query (overrides --epic and --project)
Action string // --action: list, close, delete
TargetStatus string // --target-status: status for close action
Yes bool // --yes: skip confirmation
Map string // --map: read jira_key from hub-style frontmatter
}
ReconcileOptions holds all resolved inputs for the issue reconcile command.
type TransitionsOptions ¶
type TransitionsOptions struct {
Factory *factory.Factory
KeyOrID string // positional arg: issue key
}
TransitionsOptions holds all resolved inputs for the issue transitions command.
type ViewOptions ¶
type ViewOptions struct {
Factory *factory.Factory
KeyOrID string
Fields []string // --fields filter
NoPager bool // --no-pager
Comments bool // --comments
Web bool // --web
// BrowserOpen is the function used to open a URL in the browser.
// Defaults to browser.OpenURL; overridden in tests.
BrowserOpen func(string) error
}
ViewOptions holds all resolved inputs for the issue view command.