Expand description
The managed blocks in review descriptions: the user’s description, the
issue-closing link, and the stack-overview ledger ([ledger]), all
built on marker-delimited [sections].
Functions§
- branch_
references_ issue - Whether a branch name references an issue git-stk would link with a
Closes #Nnote. Lets the caller predict whether a seeded template will be followed by managed content (and so needs a seam rule). - seed_
template_ notes - Seed each freshly created review’s body with the repo’s PR/MR template, so
the managed sections below augment it instead of
--fillreplacing it. Create-only - existing reviews keep whatever body they have - and skipped whenstk.usePrTemplateis off or the repo has no single template. Each entry is a freshly created branch and whether git-stk will write a managed section (description,Closes #N, or stack overview) into its review below the template - which decides whether a seam rule is seeded. - update_
closes_ notes - Add a
Closes #Nline to each branch’s review when the branch name references an issue (e.g.123-fix-thing,fix/issue-123), so the platform closes the issue when the review merges. Branches without an issue reference are passed over silently. - update_
description_ note - Write (or, with an empty string, clear) the description block in the
branch’s review body. Unlike the stack overview the block is sticky:
submits without
--descnever touch it. - update_
stack_ notes - Maintain a stack overview in every review body: the full ledger leaf-first, the trunk at the bottom, and a pointing emoji marking the review being viewed. Lives between marker comments so refreshes replace it in place, and self-repairs if the markers were hand-edited away. Merged and closed entries are preserved from the previous note and restyled instead of dropped.