CI / build (push) Has been cancelled
- Archive 79 completed framework-dev tasks from tasks/ -> tasks/complete/ - status.py: add --cleanup-done and --install-cleanup-schedule commands - Add scripts/automaton-cleanup.sh for periodic task archiving - Dashboard: rename 'Background' tab -> 'Agent', 'Cleanup' agent -> 'Completed Task Archiver', remove redundant group headers and pill badges, dim inactive agent placeholders - .rules.md: add Self-Documenting UI Names rule - New tests: test_cleanup_done.py, expanded test_app.py and test_task.py
3.4 KiB
3.4 KiB
SPEC: Additive Extension Model for Project Upgrades
Overview
Replace the current diff/merge upgrade process with a simpler additive extension model. Projects should never copy framework files. Instead, they provide overrides via .agent.md, .rules.md, and an optional extensions/ directory. Updating the framework becomes a simple git pull with no project-level file comparison.
Motivation
The current design has a design-vs-reality gap:
| Design Intent | Reality |
|---|---|
Projects only have .agent.md + .rules.md |
Projects have full copies of framework files |
| Additive overrides only | Diff/merge required on upgrade |
Simple git pull update |
Complex file-by-file comparison |
The root cause: orchestrate.md reads prompts/contracts/scripts from the project first, then falls back to global. This encourages copying files into the project, which breaks the clean separation.
Required Changes
1. prompts/orchestrate.md
Remove the project-first fallback for prompts, contracts, and scripts. The Orchestrator should:
- Always read base prompts/contracts/scripts from
~/.automaton/(global) - Check
{project}/.automaton/extensions/for additive extensions (not replacements) - Specific extension files to check:
{project}/.automaton/extensions/prompts/*.md- loaded after the corresponding global prompt{project}/.automaton/extensions/contracts/*.md- loaded after global contracts{project}/.automaton/extensions/scripts/*.sh- loaded before global scripts (to allow pre-processing)
- The read order for
.agent.mdstays layered (project override is correct for routing)
2. prompts/onboarding.md
- Remove the "Project Upgrade" section (lines 99-155) that performs diff/merge
- Simplify to: if
.agent.mdor.rules.mdare missing, create minimal defaults - Add documentation for the
extensions/directory pattern - Remove any instructions that copy framework files into the project
3. scripts/update.sh
- Simplify: remove the reset hard HEAD step. Just
git pullwith a clean working tree check. - Ensure it only touches
~/.automaton/, never project directories
4. README.md
- Update the "Upgrading existing projects" section to describe the new additive model
- Document the
extensions/directory pattern
Acceptance Criteria
prompts/orchestrate.mdreads prompts/contracts/scripts from~/.automaton/first, not from projectprompts/orchestrate.mdchecks{project}/.automaton/extensions/for additive extensionsprompts/onboarding.mdno longer has diff/merge upgrade logicprompts/onboarding.mdcreates minimal.agent.mdand.rules.mdif missingprompts/onboarding.mddocuments theextensions/directoryscripts/update.shdoes a simplegit pullwithout resetting local changesREADME.mddescribes the new upgrade model- No existing prompt/contract/script behavior is broken (regression check)
Non-Goals
- Moving the dashboard (
automaton/dashboard/) - it already reads from~/.automaton/at runtime - Changing how
config.mdis read (already always global perorchestrate.mdline 15) - Changing the task directory structure
Notes
- The
invest-copilotproject has a full copy of the framework in its.automaton/- this task should include a migration path to clean it up - The extension model should be documented in
references/extensions.mdas well