Skip to content

Phase 1 — Generate Plan

Phase 1 fetches Jira issues matching a JQL query, optionally enriches them with child issues, then writes an Excel plan file for human review.

Command

jira-runner \
  --project <KEY> \
  --yaml transition.yaml \
  --jql "<JQL>" \
  --plan <output.xlsx> \
  [--include-children]
Flag Required Description
--project Yes Jira project key (e.g. PROJ)
--yaml Yes Path to workflow YAML
--jql Yes JQL to select issues
--plan Yes Output Excel file path
--include-children No Recursively fetch child issues

With Hierarchy Lookup

jira-runner \
  --project PROJ \
  --yaml transition.yaml \
  --jql "project = PROJ AND issuetype = Epic AND status = 'QA Sign-off'" \
  --plan plan.xlsx \
  --include-children

Hierarchy levels resolved:

Level Type
2 Initiative
1 Epic
0 Story / Task
-1 Subtask

Children with status category Done are excluded. If any child is an open bug (see BUG_ISSUE_TYPES in settings.toml), the parent row's approved column defaults to False and the bug keys appear in remarks.

Without Hierarchy Lookup

jira-runner \
  --project PROJ \
  --yaml transition.yaml \
  --jql "project = PROJ AND sprint = 'Sprint 42'" \
  --plan plan.xlsx

Faster — skips child resolution. Useful when you only need to transition the queried issues themselves.

Output Excel Format

Column Description
issue_key Jira issue key
summary Issue summary
issuetype Issue type name
current_status Status at time of plan generation
target_status User selects — dropdown of valid target statuses; smart default pre-filled in blue bold
approved User sets — True / False; auto-False when open bugs detected
remarks Open bug keys, parent references

Smart Defaults

The target_status cell is pre-filled with the highest-priority reachable status (configured via PRIORITY_STATUSES). Override by selecting a different option from the dropdown before executing.