Byron/gitoxide git-repository-v0.21.0

git-repository v0.21.0

on GitHub

Changed

• Invert behaviour to open::Options::strict_config(), with lenient being the default.
  This means API users will get libgit2 behaviour but commands like gix can
  change options to emulate git behaviour.

New Features

• Kind can now represent submodules.
  This should complete the list of git repository types and flavors.
• open() and discover() support opening submodules.
  This includes submodule checkouts as well as their original module git
  directories.
• open::Options::lenient_config(…) to default otherwise invalid configuration values where possible
  Originally required by starship/starship#4266 .
• support core.worktree option
• display for object::tree::EntryRef
• Head::prior_checked_out_branches()
• Repository::index() and Worktree::index().
  These methods provide a possibly updated shared index.
• add Repository::object_cache_size_if_unset()
• Commit::message_raw_sloppy() to provide yet another way to obtain a commit message.
• add rev_spec::parse::ObjectKindHint to support core.disambiguate.
  The latter is seemingly undocumented in the typical place, git-config.

Bug Fixes

• assure permissions per trust level are properly inherited into open::Options.
• provide additional explanation about when to use open::Options::with()

Refactor

• embrace revision module and move rev_walk there.
  Let's embrace the idea of structured modules and platforms in the right
  spot in the module hierarchy instead of forcing known names on it that
  over-simplify.

Changed (BREAKING)

• remove permissions::Config::strict() as they were unused internally.
  Furthermore, they were allowing everything as before so better not to
  have it.

• rename Repository::load_mailmap* to Repository::open_mailmap*.
  For consistency with other similar methods.

• remove Repository::load_index() in favor of repo.worktree().open_index().

• git_revision is now available in revision::plumbing.
  That way it won't clash with the higher-level constructs on top of it
  which use the same names.

• Turn id::Ancestors into general-purpose RevWalk.

• remove Permissions::git_dir field entirely.
  It was meant to help dealing with bailing out if the git dir isn't
  fully trusted, but the way this was done was over-engineered especially
  since the read-only permission level wasn't implemented at all.

  That function is now performed by a new flag, the bail_on_untrusted
  which is off by default.

New Features (BREAKING)

• Repository::rev_parse() returns a RevSpec.
  This lays the foundation for actually handling rev-specs faithfully.
  Previous users should use rev_parse().single() to obtain a single
  object id which was the only supported usecase previously.

Bug Fixes (BREAKING)

• Don't panic for @{1} in new repos; rename Head::into_referent() to ::try_into_referent()
  The signature change will prevent such issues in the future as one
  cannot simply ignore new repositories.

Commit Statistics

• 133 commits contributed to the release over the course of 26 calendar days.
• 26 days passed between releases.
• 22 commits where understood as conventional.
• 2 unique issues were worked on: #427, #482

Thanks Clippy

Clippy helped 6 times to make code idiomatic.

Commit Details