Fintan Halpenny
9b5ea4352f
The aim of this commit is to better represent the reference names using git-ref-format. The first places to change were the Branch and Tag types. For Branch, the previous types were simply wrappers around the names. They stay this way, using RefString instead. For Tag, the `name` field is replaced with RefString. Note: The parsing logic becomes easier here by utilising the Namespaced and Qualified types. The consequences of these changes meant that areas that used BranchName or TagName are changed to use RefString. Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com> X-Clacks-Overhead: GNU Terry Pratchett
radicle-git
The home for all Git utilities related to Radicle. While the majority of the utilities will attempt to be general, there may be more opinionated parts that are geared towards Radicle.
Motivation
The git2 and gitoxide libraries provide low-level APIs for interacting with git repositories and the git protocol. This family of crates attempts to provide a higher-level wrapper around those to provide a more useful API for the Radicle protocol and UI clients building on top of the protocol.
Overview
The repository is defined as a series of crates:
git-ext-- provides higher-level types over common types found ingit2.git-ref-format-- provides a higher-level API for constructing git. reference paths. Prefer this overgit-ext'sRefLikeandRefspecPattern.git-trailers-- provides a way to parse and construct git trailers.git-types-- provides higher-level types, e.g.Namespace,Reference,Remote, etc.link-git-- provides a higher-level API for git'srefdb,odb, and the git protocol.macros-- provides macros for thegit-extreferences types.std-ext-- provides some utilities extending the standard library.test-- a shim crate that refers depends on all other, individual test crates.
Tests
Please refer to test/README.md for understanding how our tests are organised.
Contribute
Please read CONTRIBUTING.md for a guide on contributing to this repository.
Credits
Thanks to the previous maintainers of the radicle-link repository,
Kim, Alex, and Fintan, for providing the foundation to work upon -- as
well as the contributors.