Skip to content

[feature-runner] Add heredoc wrapping note to PR body template in runner-output-formats.md #91

@orioltf

Description

@orioltf

This was generated by AI during triage.

Parent

docs/issues/feature-runner/PRD.md

What to build

The PR body template in references/runner-output-formats.md shows the multiline body content but gives no instruction on how to pass it to gh pr create. Step 7 of SKILL.md currently shows --body "<PR body template with substitutions>" as a placeholder, but an agent executing the step has no guidance on quoting a multiline string for the --body flag.

Add a "how to use" note directly under the PR body template in references/runner-output-formats.md showing the bash heredoc wrapper:

Pass via a bash heredoc:

gh pr create \
  --base develop \
  --title "feat(<slug>): <PRD title>" \
  --body "$(cat <<'EOF'
<substituted body content>
EOF
)"

No changes to SKILL.md are needed — step 7 already directs the agent to references/runner-output-formats.md for the body template.

Acceptance criteria

  • The PR body template section in references/runner-output-formats.md includes a note explaining that the body must be passed via a bash heredoc
  • The note shows a complete, correct gh pr create command with the heredoc wrapper
  • SKILL.md step 7 is unchanged
  • No other sections of references/runner-output-formats.md are modified

Blocked by

#89

Comments

This was generated by AI during triage.

Agent Brief

Category: enhancement
Summary: Add heredoc wrapping instruction to the PR body template in references/runner-output-formats.md so agents know how to pass multiline content to gh pr create.

Current behavior:
The PR body template section shows the body content in a fenced code block but gives no instruction on how to embed it in a gh pr create call. Step 7 of SKILL.md shows --body "<PR body template with substitutions>" as a placeholder — an agent executing this step has no guidance on quoting a multiline string for --body.

Desired behavior:
The PR body template section in references/runner-output-formats.md includes a follow-on note showing the complete gh pr create command with the body content wrapped in a bash heredoc (--body "$(cat <<'EOF' ... EOF)"). An agent reading the section finds both the template content and the exact quoting pattern needed to use it.

Key interfaces:

  • The PR body template section in references/runner-output-formats.md — gains a "how to use" note after the fenced code block
  • SKILL.md step 7 — unchanged; it already directs the agent to the references file

Acceptance criteria:

  • The PR body template section in references/runner-output-formats.md includes a note explaining that the body must be passed via a bash heredoc
  • The note shows a complete, correct gh pr create command with the heredoc wrapper
  • SKILL.md step 7 is unchanged
  • No other sections of references/runner-output-formats.md are modified

Out of scope:

  • Changing the PR body template content itself
  • Adding cross-platform alternatives to the heredoc (the cross-platform concern pre-dates this issue and is not being addressed here)
  • Modifying SKILL.md

PRD: docs/issues/feature-runner/PRD.md
Migrated from: docs/issues/feature-runner/12-heredoc-note-in-references.md (source removed after migration)
Touched by PRs: #25, #32

Metadata

Metadata

Assignees

No one assigned

    Labels

    closedPR has been mergedenhancementNew feature or requestfeature/feature-runnerIssues from the feature-runner feature

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions