Skip to content

docs: commit .comline/; the scaffold ignores only fetched dependencies #104

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
Kinflou merged 1 commit into from
Oct 31, 2026
Merged

docs: commit .comline/; the scaffold ignores only fetched dependencies #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ my-api/
├── comline.toml # where generated code goes (all-commented by default)
├── src/
│ └── main.ids # a sample schema
└── .gitignore # ignores .comline/
└── .gitignore # ignores .comline/deps-cache/
```

`src/main.ids`:
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/guide/packages/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ After the first `comline build`, a `.comline/` directory holds the
(`refs/heads/main`). It is the authoritative, append-only history of the
package's versions, and the only copy of it — nothing pushes it anywhere yet.

The `comline new` scaffold git-ignores it, which suits tests and examples. A
package with a version history worth keeping should either commit `.comline/` or,
once [publishing](#publishing-planned) exists, publish it.
Commit it. Nothing publishes it yet, so a clone without it starts over with no
recorded versions. The `comline new` scaffold's `.gitignore` ignores only
`.comline/deps-cache/`, where [git dependencies](#dependencies) are fetched.

!!! warning
`comline reset` deletes `.comline/` (behind a confirmation). `comline clean`
Expand Down
Loading