Byron/gitoxide git-repository-v0.30.0

git-repository v0.30.0

on GitHub

Changed

• represent GIT_(COMMITTER|AUTHOR)_(NAME|EMAIL|DATE) with git configuration.
  That way it becomes more obvious where values are coming from.

New Features

• expose git-features crate at root under features.
  That way application developers can use more of the utilities
  that power most of the gitoxide plumbing crates.

• Remote knows about its tagOpt configuration.
  That way it's clear if it should or shouldn't fetch included/reachable
  tags automatically.

  The default setting for this is to include tags, similar to git.

  The fetch_tags() accessor allows to query this information, and the
  with_fetch_tags() builder method allows to set the value comfortably
  right after creating the Remote instance.

  The tagOpt key will also be written as part of the remote's git
  configuration.

  Clone operations can set the Tags setting when configuring the
  remote in a callback.

  This also comes with a fix to assure that ref-updates aren't skipped
  just because there was no pack to receive. That way, locally missing
  refs or tags will automatically be put back.

• network related Error type support is_spurious() method.
  That way the caller can determine more easily if it makes sense
  to try again.

• Make prodash::tree avaialble as progress::tree.

• read worktree specific configuration to override the one from the shared repository.
  This is intensively used when space checkouts are created, along with
  Cone mode. Thus it's the basis for properly interpreting sparse checkout
  options which are set on a per-worktree basis.

• add permissions::Environment::http_transport.
  That way it's possible to deny using environment variables that affect
  the HTTP transport, like setting the proxy.

• open::Options::modify() as general pattern to allow builder methods usage in &mut self.
  That way it's easier to configure both the full and the partial trust instances
  of discovery options.

• Add Repository::commit_as(committer, author, …) convenience method.
  That way it's, very much beyond convenience, possible to set the time
  of a commit.

  Many thanks to @epage for the suggestion.

• upgrade to prodash 21.1 and add Ids to all progress instances.
  That way callers can identify progress they are interested in, say, for
  selective visualizations.

Bug Fixes

• provide a clearer error message when trying to open a git repository that isn't one.

• http transports can now reuse a connection.
  This makes connections more efficient generally and cargo relies
  on that behaviour in their tests as well.

• allow to open a Repository from if 'config' file is missing.
  In this case, treat it similar to having an empty repository configuration
  file and assume defaults everywhere.

• improve error verbosity when fetching and cloning

• tree::diff::Platform::for_each_to_obtain_tree() now properly surfaces user provided errors.
  Previously it would squelch them unintentionally.

  First discovered via Byron/crates-index-diff-rs#35.

• when fetching from file://, don't upset windows by trying d:/foo, use d:\\foo instead.

• config::CommitAutoRollback now implements DerefMut.

Changed (BREAKING)

• default features are set to max-performance-safe to assure compatibility.
  Previously the max-performance setting might have caused issues during compilation
  or issues at runtime if libraries like git2 are used in the same binary, and the
  new default feature settings maximizes compatbility so this won't happen.

  For best performance, however, one will have to activate the max-performance
  feature on top of that.

• environment variable permissions are per topic.
  Now Permissions for environment variables are so that they
  are by topic instead of by prefix, by default. That way
  it's easier to allow or deny particular sets of related
  environment variables.

  The catch-all permissions by prefix are still present for all
  other variables that aren't contained in one particular topic.

• open::ReplacementObjects is removed in favor of two custom git-configuration flags.
  Now it's possible to map the environment variables GIT_REPLACE_REF_BASE and GIT_NO_REPLACE_OBJECTS
  to custom git configuration keys which can also be set, namely gitoxide.odb.replaceObjectsRefBase
  and gitoxide.odb.noReplaceObjects.

  Along with the possibility of disabling the usage of GIT_ prefixed environment variables one
  reaches the previous level of control without making object replacement a special case.

New Features (BREAKING)

• interrupts::init_handler() can now be undone.
  This can be done by calling deregister() or auto_deregister() on the return value
  of interrupts::init_handler(…).

  That way it's possible to temporarily do interrupt handling only while some methods
  that rquire it are running.

• represent object cache configuration like GITOXIDE_PACK_CACHE_MEMORY in git-configuration.
  That way there is a unified system for how to set values, which may be overridable by configuration
  variables or not.

  With this changes, the explicit application of environment variables for setting the cache
  isn't required anymore as everything happens using git-configuration, and automatically,
  while providing full control like before.

• remove SnapshotMut::apply_cli_overrides() in favor of open::Options::cli_overrides().

• more type-safety for remote names by making clear they can be named after URLs.

Other (BREAKING)

• Remote::with_refspec() to Remote::with_refspecs() to allow adding more than one refspec as part of the builder.

Commit Statistics

• 74 commits contributed to the release over the course of 27 calendar days.
• 27 days passed between releases.
• 25 commits were understood as conventional.
• 0 issues like '(#ID)' were seen in commit messages

Thanks Clippy

Clippy helped 2 times to make code idiomatic.

Commit Details