Skip to content

buildPrBody

Writes the PR body.

Import:

import { buildPrBody } from '@mnaoumov/typescript-dev-toolkit/upstream-sync';

Signature:

function buildPrBody(plan: SyncPlan, steps: StepResults | null, diffStat: string | null): string

Parameters:

Parameter Type Description
plan SyncPlan The plan.
steps StepResults | null The handler and verify runs, or null in a dry run, where neither runs.
diffStat string | null git diff --stat of the update commit, or null in a dry run.

Returns: string — The body, in Markdown.