/theway:archive

Use it once the change is implemented, tested, deployed when that applies, and confirmed working.

UsageCopy Anchor Link

/theway:archive <change-id>

ExampleCopy Anchor Link

On my-api, once the full change example's change is done:

/theway:archive add-rate-limiting

Archived: <home>/projects/-home-you-code-my-api/changes/archive/YYYY-MM-DD-add-rate-limiting

StepsCopy Anchor Link

1. Require an explicit instruction. Archiving moves the folder, so it runs only when you name the change and say to archive it. Signals such as "it's merged" or "ship it" are not enough: it stops and asks.

2. Verify completion. It runs theway list and shows the task count. If the change is not at N/N tasks done, it shows the open tasks and asks you to fix them or accept an override. A task that is done is ticked with theway task done.

3. Move to the archive:

   Copy Text

   theway archive <change-id>
   # only when you accept the remaining open tasks:
   theway archive <change-id> --force

   The CLI also refuses while a task is open or the change's change.yaml is invalid, unless --force is given: the command then shows the error lines it printed and uses --force only on your explicit acceptance. It also refuses when changes/archive/YYYY-MM-DD-<change-id>/ already exists, for example the same change archived twice in one day.

4. Confirm: it reports the Archived: <path> line theway archive prints.

OutputCopy Anchor Link

The whole change folder (spec.md, change.yaml, design.md, notes.md and any other file) moves to:

<home>/projects/<key>/changes/archive/YYYY-MM-DD-<change-id>/

<home> is the folder theway path prints, ~/.theway by default.

See Changes and theway archive.