Debug a plan

Pause a failing plan at a breakpoint, find the bad input, and fix the step.

unreleased_changes fails at its commits step.

.graph/plans/unreleased_changes.yaml

version: 2
identifier: unreleased_changes
name: Unreleased changes
description: The commits since the latest release.
steps:
- id: release
  tool_name: github__tool__gh_release
  input: {}
- id: commits
  tool_name: github__tool__git_log
  input:
    base: '{{release.url}}'
    head: HEAD
finish:
  output:
    since: '{{release.tag}}'
    commits: '{{commits.commits}}'

1. Open the plan in the workbench

   graph workbench plan \
     unreleased_changes
   
2. Set a breakpoint

   Press Tab to focus the steps, select commits with j and k, and press b.

3. Start a debug run

   Press g. The run calls release and pauses before commits, showing the input it’s about to send:

   

   Paused before commits: base is the release's URL, not its tag.

   base is the release page’s URL, which git can’t read as a revision. It should be the release’s tag.

4. Fix the step

   Press a to stop the run. With commits selected, press e, change base to {{release.tag}}, and press Ctrl+S to apply it.

5. Run it again

   Press r. The run finishes, and 3 opens the run tab with each step’s result.

6. Save

   Press Ctrl+S to write the fix to ./.graph/plans/unreleased_changes.yaml.

Related guides

Handle failures

Tell why a run failed and choose how to respond.

Run a plan

Run a plan with inputs and use its result.

Draft a plan in the workbench

Turn a goal into a working, saved plan.

Plan file

Every field a plan file takes.