Skip to content
This repository was archived by the owner on Feb 24, 2026. It is now read-only.

Commit a0b88cd

Browse files
docs: add known issue for Starship ignore_bare_repo with gitdir pointer (#13)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 83918cc commit a0b88cd

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,18 @@ Files at the project root are outside version control. They're excluded via
188188
`.bare/info/exclude` (not `.gitignore`). The `setup` task pre-populates common patterns.
189189
To add your own, edit `.bare/info/exclude` directly.
190190

191+
## Known issues
192+
193+
### Starship shows branch name at the project root
194+
195+
[Starship](https://starship.rs/)'s `git_branch` module has an `ignore_bare_repo` option, but
196+
it doesn't work with the gitdir pointer pattern (`.git` file pointing to `.bare/`). This is
197+
because Starship uses [gitoxide](https://github.com/GitoxideLabs/gitoxide) which
198+
[doesn't follow gitdir indirection when checking `is_bare()`](https://github.com/GitoxideLabs/gitoxide/issues/2402).
199+
200+
The fix has been merged in gitoxide and is expected in the gitoxide release on 2026-02-22,
201+
after which Starship needs to bump its gitoxide dependency.
202+
191203
## Credit
192204

193205
Based on the workflow from Ahmed el Gabri:

0 commit comments

Comments
 (0)