GHPP icon

GHPP

Run ghpp promote/demote to manage GitHub Project Issue items

Promote

AI-generated

Summary

Promote GitHub Project Issue items to the next status according to a configurable workflow, advancing issues through stages like Backlog, Plan, Ready, and In progress.

Inputs

  • Workflow — Selects the workflow mode ('Full': Backlog -> Plan -> Ready -> In progress, or 'Simple': Backlog -> In progress only). Controls which status transitions are performed.
  • Owner (required) — GitHub owner (user or organization) to identify the project repository.
  • Project Number (required) — Number identifying the GitHub Project to operate on.
  • Plan Limit — Maximum number of items to promote into the Plan status (applicable only in 'Full' workflow).
  • Dry Run — If true, simulates the promotion without making changes to the GitHub Project.
  • Promote Plan Enabled — Enables or disables automatic promotion of items from Backlog to Plan.
  • Promote Ready Enabled — Enables automatic promotion of items from Plan to Ready when they have the specified planned label.
  • Planned Label — Name of the label that triggers promotion from Plan to Ready (used only if Promote Ready is enabled).
  • Status Settings — Customizable status names for Inbox (Backlog), Plan, Ready, and Doing (In progress) stages.

Output shape

a list of JSON objects, each representing the result of the promotion command execution per input item

Each output item contains the parsed JSON result from the underlying 'ghpp promote' command, or raw output if parsing fails. Errors during execution are raised as node errors. Supports processing multiple input items with independent parameters.

Examples

Example 1: Promote items using full workflow with default settings

Owner='my-org', Project Number=1, Workflow='full', Plan Limit=3, Promote Plan Enabled=true, Promote Ready Enabled=false, Dry Run=false

Example 2: Run promotion in dry-run mode to preview changes

Dry Run=true (no changes applied), other parameters as needed

Links

Discussion