feat: Archiving, Documentation, and Changelog #563

New issue

Closed

opened 2025-10-14 16:02:47 -06:00 by navan · 0 comments

navan commented

2025-10-14 16:02:47 -06:00

Owner

Originally created by @orakemu on 6/8/2025

Motivation

Over time, completed and obsolete tasks clutter the workspace. Archiving and changelogs keep the active list clean, create an audit trail, and generate helpful documentation for future reference.

Proposed Solution

Add a status field (e.g., backlog, inprogress, done, archived) to YAML metadata.
“Archiving” changes the status field to archived (no file moves required).
Scripts can scan for archived/done tasks and generate/update documentation or changelog.md files.
Optionally, provide commands to view or summarize archived/completed work.

High-Level Workflow

Update YAML schema to include status (with archived).
Provide commands to change task/project status.
Implement scripts to scan all .md files and aggregate archived/done items into changelog and docs.
Update documentation.

Key Elements

status: archived in YAML
Changelog/documentation generation scripts
CLI commands for status changes and archiving

Example Workflow

$ task-master archive-task --id 42
→ Task 42 marked as archived

$ task-master generate-changelog
→ Changelog updated with 3 new completed tasks

Implementation Considerations

File locking or concurrent edits
Changelog size and performance on large repos
Backward compatibility for existing tasks

Out of Scope (Future Considerations)

Automated archiving based on task age
UI for browsing archived/completed tasks

*Originally created by @orakemu on 6/8/2025* ### Motivation Over time, completed and obsolete tasks clutter the workspace. Archiving and changelogs keep the active list clean, create an audit trail, and generate helpful documentation for future reference. ### Proposed Solution - Add a status field (e.g., backlog, inprogress, done, archived) to YAML metadata. - “Archiving” changes the status field to archived (no file moves required). - Scripts can scan for archived/done tasks and generate/update documentation or changelog.md files. - Optionally, provide commands to view or summarize archived/completed work. ### High-Level Workflow 1. Update YAML schema to include status (with archived). 2. Provide commands to change task/project status. 3. Implement scripts to scan all .md files and aggregate archived/done items into changelog and docs. 4. Update documentation. ### Key Elements - status: archived in YAML - Changelog/documentation generation scripts - CLI commands for status changes and archiving ### Example Workflow ```shell $ task-master archive-task --id 42 → Task 42 marked as archived $ task-master generate-changelog → Changelog updated with 3 new completed tasks ``` ### Implementation Considerations - File locking or concurrent edits - Changelog size and performance on large repos - Backward compatibility for existing tasks ### Out of Scope (Future Considerations) - Automated archiving based on task age - UI for browsing archived/completed tasks