Draft a plan in the workbench

Draft unreleased_changes, a plan that writes a one-line release note for each commit since the latest release, then save and run it.

Draft the plan

1. Open the workbench in plan mode

   graph workbench plan
   
2. Describe the goal

   Say what the plan should produce and from what:

   a plan that writes a one-line release
   note for each commit since the latest
   GitHub release, from its subject and
   the files it changed
   

   The plan drafter finds the tools for each part of the goal, writes the plan, checks it, and puts it in the pane:

   

   The drafted plan in the pane: the release, the commits since it, each commit's changed files, and one infer step that writes the notes.

3. Answer its questions

   The drafter may ask for clarification on statuses or labels that it needs to draft the plan. Answer the questions in the form to continue.

   

   The drafter's questions, each filled in with its guess.

4. Rename it

   The plan editor takes over once the draft is in the pane. Ask it for the identifier you want:

   rename it unreleased_changes
   
5. Save

   Press Ctrl+S. graph writes the plan to ./.graph/plans/unreleased_changes.yaml.

Run the plan

graph plan run unreleased_changes

{
  "release_tag": "v0.15.0",
  "release_notes": [
    {
      "note": "Plans now declare a required finish key, returning the plan's result shape on success and one standard error shape on failure",
      "sha": "648d34e",
      "short_sha": "648d34e"
    },
    {
      "note": "Workbench agents now work on plans through the same artifact tools as agents and tools, folding 17 workbench tools into 7",
      "sha": "cd01c05",
      "short_sha": "cd01c05"
    }
  ],
  "commits": [ … ]
}

Related guides

Debug a plan

Step through a run in the workbench.

Plan file

Every field a plan file takes.

Create a tool in the workbench

Draft a tool the plan needs.