Add packet cleanup hygiene doctrine
This commit is contained in:
axiomlogicnexus
parent
c9583b82da
commit
879bc88ffc
3 changed files with 186 additions and 0 deletions
|
|
@ -306,6 +306,18 @@ When `Model A` evaluates or refreshes a retained repo, the output should try to
|
|||
|
||||
- when the row is clean-room-sensitive, make the source-access boundary explicit
|
||||
|
||||
### Post-evaluation artifact hygiene
|
||||
|
||||
- if the source-evaluation packet ran builds, installs, tests, or other local
|
||||
validation, finish the packet docs first and then clean rebuildable
|
||||
byproducts
|
||||
- keep custody mirrors, packet docs, and required handoff artifacts
|
||||
- remove temporary evaluation worktrees, temporary clones, and rebuildable
|
||||
outputs when they are no longer needed
|
||||
- use
|
||||
`docs/ops/HYPERTWIST_PACKET_CLEANUP_AND_REBUILDABLE_ARTIFACT_HYGIENE_2026-05-20.md`
|
||||
as the governing cleanup doctrine
|
||||
|
||||
## Retroactive interpretation rule for existing packets
|
||||
|
||||
This doctrine applies retroactively to the already closed HyperTwist packets.
|
||||
|
|
@ -356,6 +368,10 @@ Use the HyperTwist docs this way:
|
|||
- canonical closeout section order
|
||||
- mandatory Result taxonomy
|
||||
- compactness-without-information-loss rule
|
||||
- `docs/ops/HYPERTWIST_PACKET_CLEANUP_AND_REBUILDABLE_ARTIFACT_HYGIENE_2026-05-20.md`:
|
||||
- post-packet cleanup order
|
||||
- rebuildable-artifact rule
|
||||
- custody-versus-cleanup boundary
|
||||
|
||||
## Practical operator rule
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,162 @@
|
|||
# HyperTwist Packet Cleanup And Rebuildable Artifact Hygiene
|
||||
|
||||
Created on `2026-05-20`.
|
||||
|
||||
Purpose:
|
||||
|
||||
- define the default cleanup rule after bounded implementation packets,
|
||||
validation-unblock packets, deep source packet evaluation, and similar
|
||||
packeted work
|
||||
- reduce stale build outputs, temporary worktrees, and disposable validation
|
||||
byproducts without deleting authority surfaces or custody material
|
||||
- make post-packet cleanup a doctrine step rather than operator memory
|
||||
|
||||
## Scope
|
||||
|
||||
This rule applies after packeted work such as:
|
||||
|
||||
- bounded implementation
|
||||
- owner-scoped validation-unblock
|
||||
- repo-local reconciliation when it generated temporary worktrees or test
|
||||
artifacts
|
||||
- deep source packet evaluation that ran builds, installs, tests, or other
|
||||
local validation
|
||||
- other packeted work that created clearly rebuildable byproducts
|
||||
|
||||
It is not permission for blind sweeping.
|
||||
|
||||
## Core rule
|
||||
|
||||
Finish the packet truth first.
|
||||
|
||||
Then clean rebuildable byproducts only.
|
||||
|
||||
Do not let cleanup destroy:
|
||||
|
||||
- packet docs
|
||||
- clean-room handoffs
|
||||
- staged notes
|
||||
- logs or reports that are still needed to write authority updates
|
||||
- custody mirrors
|
||||
- reference archives
|
||||
- plausible user-owned dirty work
|
||||
|
||||
## Required cleanup order
|
||||
|
||||
1. finish the packet closeout and authority updates
|
||||
2. keep any required clean-room handoff, packet note, commit, or exported
|
||||
evidence that the packet still needs
|
||||
3. remove rebuildable byproducts from the temporary packet root
|
||||
4. remove the temporary worktree or temporary evaluation clone unless the user
|
||||
asked to keep it or a documented blocker requires temporary retention
|
||||
5. if a registered git worktree was deleted manually, run `git worktree prune`
|
||||
from the controlling repo
|
||||
6. verify git state after cleanup
|
||||
|
||||
If cleanup cannot be completed safely, say what was retained and why.
|
||||
|
||||
## Default rebuildable cleanup classes
|
||||
|
||||
These are normally cleanup targets when they were created by the packet and are
|
||||
not themselves authority:
|
||||
|
||||
- `.vs`
|
||||
- `x64`
|
||||
- Unreal `Binaries`
|
||||
- Unreal `DerivedDataCache`
|
||||
- Unreal `Intermediate`
|
||||
- Unreal `Saved`
|
||||
- plugin-local `Binaries`
|
||||
- plugin-local `Intermediate`
|
||||
- worktree-local `logs`
|
||||
- worktree-local `Saved/Logs`
|
||||
- automation report exports
|
||||
- JSON roundtrip validation artifacts
|
||||
- packet-local `-AbsLog` outputs
|
||||
- other clearly rebuildable validation or build outputs created inside the
|
||||
temporary packet root
|
||||
|
||||
For non-Unreal packet roots, the same rule applies to equivalent rebuildable
|
||||
outputs such as:
|
||||
|
||||
- `node_modules`
|
||||
- `target`
|
||||
- `.next`
|
||||
- `dist`
|
||||
- `build`
|
||||
- `out`
|
||||
- local virtual environments
|
||||
- local caches
|
||||
|
||||
Only clean those when they were created for the packet and are not being kept
|
||||
as authority.
|
||||
|
||||
## Default non-targets
|
||||
|
||||
These are not routine cleanup targets unless the user explicitly asks:
|
||||
|
||||
- `.git`
|
||||
- committed source trees
|
||||
- `docs`
|
||||
- `docs/ops`
|
||||
- `docs/refs`
|
||||
- `clean-room-specs`
|
||||
- `clean-room-specs/outputs`
|
||||
- `mirrors`
|
||||
- `zippedreposource`
|
||||
- reference archives
|
||||
- root-level research or tutorial assets
|
||||
- long-lived custody or provenance surfaces
|
||||
- the dirty main worktree when it contains pre-existing or ambiguous residue
|
||||
|
||||
## Deep source evaluation rule
|
||||
|
||||
Deep source packet evaluation is allowed to build, install dependencies, or run
|
||||
tests when that is needed for a serious source-backed judgment.
|
||||
|
||||
After the packet closes:
|
||||
|
||||
- keep the packet docs and any required custody pointers
|
||||
- keep the mirror if it is a named custody surface
|
||||
- clean rebuildable byproducts created by the evaluation
|
||||
- remove temporary evaluation clones or temporary evaluation worktrees that are
|
||||
no longer needed
|
||||
|
||||
Do not casually delete the custody mirror itself merely because validation ran
|
||||
near it.
|
||||
|
||||
## Worktree rule
|
||||
|
||||
Default temporary HyperTwist packet worktrees belong under:
|
||||
|
||||
- `C:\Workspaces\HyperTwist-worktrees\...`
|
||||
|
||||
Do not create new ad hoc root-level packet folders such as `C:\HTB*` unless the
|
||||
user explicitly approves that exact placement.
|
||||
|
||||
Preferred cleanup for a registered worktree:
|
||||
|
||||
- `git -C <controlling-repo> worktree remove <path>`
|
||||
|
||||
If the folder was already deleted manually:
|
||||
|
||||
- `git -C <controlling-repo> worktree prune`
|
||||
|
||||
## Verification rule
|
||||
|
||||
After cleanup:
|
||||
|
||||
- verify the controlling repo git status
|
||||
- verify the workspace repo git status when the packet used the workspace repo
|
||||
- if dirty state remains, distinguish packet dirt from pre-existing residue
|
||||
|
||||
## Closeout rule
|
||||
|
||||
Packet closeouts should say, at minimum:
|
||||
|
||||
- what temporary packet root was used
|
||||
- whether it was removed
|
||||
- what artifacts were intentionally retained
|
||||
- what cleanup could not be completed and why
|
||||
|
||||
That statement may be compact, but it must not be omitted.
|
||||
|
|
@ -9,6 +9,14 @@ Purpose:
|
|||
of ad hoc root-level folders
|
||||
- make cleanup expectations explicit after bounded implementation packets
|
||||
|
||||
Relationship note:
|
||||
|
||||
- this document is the worktree-focused subset of the broader cleanup doctrine
|
||||
in
|
||||
`C:\HyperTwist\docs\ops\HYPERTWIST_PACKET_CLEANUP_AND_REBUILDABLE_ARTIFACT_HYGIENE_2026-05-20.md`
|
||||
- use the broader doctrine for deep source packet evaluation and other packet
|
||||
types that generate rebuildable artifacts outside bounded implementation
|
||||
|
||||
Policy:
|
||||
|
||||
- Do not create new ad hoc packet worktrees directly under `C:\` such as
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue