Repository navigation
Intended way of storing / clean up of all markdown artifacts after a sucessful workflow? #176
|
These skills / workflow generate lots of documents per feature. Let's take a Brownfield project for example; I run the egm-bootstrap and get all these readme files in project root and subfolders. Then i want to build a feature (using git worktrees) and this process generates even more markdown files. At the end when everything is done, I might not want to keep the generated ones (from egm-brainstorm etc). If i wanted to remove or archive all the generated markdown files after complete feature, how would you suggest i do that in an efficient way? How are the Google Developers handling this case, or do all files just get pushed to git repo in all cases? |
Replies: 1 comment
|
You're not meant to commit all of it. The approved design doc goes in What's documented
There's no documented archive or cleanup step. #110, still open, asks for a default output folder. In that issue, the author of #118 describes their own setup: intermediate docs in an untracked With worktrees (my suggestion, not documented) Put echo '.dev/' >> "$(git rev-parse --git-common-dir)/info/exclude" # or commit it to .gitignoreWhen the feature is done, commit the design doc, then archive or drop the rest: # optional archive, from inside the feature worktree
mkdir -p ~/egm-archive && mv .dev/docs ~/egm-archive/"$(git branch --show-current | tr / -)"
# from the main checkout; ignored files are removed with the worktree, no --force needed
git worktree remove ../my-featureFor files left in the repo root from earlier runs, run this from the root. git clean -n -- concepts_brief.md discussion_summary.md design_draft.md \
zoom_out_report.md comprehension_report.md critic_report.md \
intermediate_zoom_out_report.md implementation_readiness_report.md \
consolidated_review_report.md goldfish_review_report.md ':(glob)*_DRIFT_REPORT.md'
|
You're not meant to commit all of it. The approved design doc goes in
docs/designs/and through a PR. Briefs, drafts and review reports can go to a folder you keep out of git, using theEGM artifact directorysetting.What's documented
EGM artifact directory: .dev/docsto your prompt or toCLAUDE.md/AGENTS.md(project or user level). Design docs stay where they are, and the docs say to add the folder to.gitignore(harnesses.md). This setting was added in #118 and ships in v0.1.0, so update the pl…