3.9 KiB
3.9 KiB
Downstream Upgrade Playbook
Owner: PM by default
Use this playbook when a downstream project wants to adopt a newer version of the minion template without overwriting project-specific state.
For first-time setup, use docs/downstream-onboarding-playbook.md instead.
Goal
Make downstream upgrades reviewable by comparing:
- the currently approved vendored template
- the incoming template version
- the live downstream files
Recommended Paths
- current approved template snapshot:
.minions-template/ - incoming candidate snapshot during upgrade:
.minions-template.next/
If the downstream repo does not already keep a vendored template snapshot, the first upgrade should establish one that matches the repo's current base-template version before attempting a larger template jump. If the repo is truly new, run the onboarding playbook first.
Both snapshot paths should contain export-ready copies of the template, not full Git clones.
- exclude
.git/ - exclude files marked
do-not-exportindocs/export-manifest.md
Ownership
PMowns the upgrade packet, merge order, and Operator-facing decision summaryAMreviews architecture and design changes that affect role boundaries, plans, or shared structureSMreviews new guardrails, security expectations, and trust-boundary changesCMapplies downstream file merges that require implementation-oriented technical judgmentOM-Test/OMreview deployment or runtime workflow changes when relevantOperatorapproves the downstream adoption decision
Upgrade Workflow
- Confirm the downstream repo's current base-template version in
minion-version.md. - Stage the current approved export-ready template snapshot in
.minions-template/if it is not already present. - Import the incoming template version into
.minions-template.next/using the same export-ready filtering rules. - Diff
.minions-template/against.minions-template.next/to see what the template changed. - Use
docs/export-manifest.mdto classify each affected live file as:template-replacemanual-mergedownstream-owneddo-not-export
- Apply
template-replacefiles first, while reviewing any intentional local downstream divergence before overwriting. - Manually merge files such as
MEMORY.md,INIT.md,docs/operator-onboarding-checklist.md, andminion-version.md. - Preserve
downstream-ownedfiles unless the Operator explicitly directs a project-specific rewrite. - Record the upgrade packet in
minions/mail/, mirror the same-day summary intominions/chat/, and update the downstreamCHANGELOG.md. - After approval, replace
.minions-template/with the new approved snapshot and remove.minions-template.next/. - Update the base-template portion of
minion-version.mdonly after the live downstream files and vendored snapshot are aligned.
Manual-Merge Guidance
MEMORY.md
- preserve project-specific facts, constraints, environments, and operating history
- merge new template guardrails, role definitions, and workflow rules
- if the file is later split into template-managed and project-managed sections, restrict template upgrades to the template-managed sections
INIT.md
- preserve the downstream project's onboarding framing and project-specific references
- merge new baseline workflow expectations, role sets, and handoff rules
docs/operator-onboarding-checklist.md
- preserve completed downstream decisions
- merge new template checklist items so future onboarding reviews stay current
minion-version.md
- preserve the downstream version suffix
- update the base-template version only after the upgrade is actually complete
Minimum PM Upgrade Packet
- current downstream version
- target template version
- files replaced from template
- files manually merged
- files intentionally left downstream-owned
- Operator decision needed
- follow-up owners and verification steps