Git Bug Rs

A rust library for interfacing with git-bug repositories.

Features

• Complete access to all git-bug entities (e.g., bugs, identities).
• Extendable, to facilitate adding your own entities.
• All git object look-ups are backed by a transparent caching layer.
• Fully compliant with the go implementation (all divergences are bugs).
• Support for entity queries, which can also be constructed programmatically.
• Incremental entity loading. Only the requested entities are cached (i.e., displaying the first 200 issues, will not need to load all issues into the cache)

Quickstart

Take a look at the documentation.

Limitations

• Currently, creating and writing, entities is not (yet) possible.
• All entity look-ups are currently unstructured, which leads to a slightly lower performance than git-bug with it's caching layer.

Performance

On a repository with 48889 issues (the rust/rust-lang issues imported into git-bug), git-gub issues list takes around 5 seconds whilst git-bug bug finishes in around 400 milliseconds. Without sorting git-gub finishes in around 2 seconds. The reason for this performance difference comes down to the missing cache layer, which means that we cannot leverage a query planner and have suboptimal cache access patterns.

Run cargo xtask bench-compare <repo with lots of issues> --poop --hyperfine to reproduce these.

Roadmap

1. Entity creation and write support.
2. Support for structured access and a caching layer.
3. Zerocopy cache entry deserialization.
4. Performance equality with git-bug.

Credits

• The original git-bug implementation (parts of it have been directly translated (e.g., the entity read code))
• Gitoxide, which provides the base for git-bug-rs.
• Taskchampion, which was a huge inspiration for writing a good API, for entities based on operations.

Licensing

This project complies with the REUSE v3.3 specification. This means that every file clearly states its copyright.