Skip to content

docs(codegen): fix .gitignore example to show target attribution comment #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
raphaelvigee merged 2 commits into from
Jul 1, 2026
Merged

docs(codegen): fix .gitignore example to show target attribution comment #59

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddc0243
docs(codegen): show target attribution comment in gitignore example
raphaelvigee Jul 1, 2026
e625baf
fix: restore missing frontmatter delimiter dropped in previous commit
raphaelvigee Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion website/docs/concepts/codegen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,20 @@ heph tool gen-gitignore
```

scans the workspace for **every** `codegen = "copy"` output and writes them into
a managed block in the root `.gitignore`:
a managed block in the root `.gitignore`, pairing each pattern with a comment
naming the target that emits it:

```text title=".gitignore"
# BEGIN heph-generated (managed by `heph tool gen-gitignore` — do not edit)
# //fmt:generated
/fmt/generated.txt
# END heph-generated
```

The attribution comment always sits on its own line directly above the pattern
it names — never trailing on the same line — since git only treats a `#` as a
comment when it starts the line.

The command is:

- **Scoped.** Only `copy` outputs are listed — `in_place` rewrites are tracked
Expand Down
Loading