git 5.5.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a27bcb58894e06dd36f368c545d7800e95b2106122d222f98e43e4776117d38
-  data.tar.gz: a59267db8db5a09e843914400be509c574670d824882b8c7a0c80f3e38945238
+  metadata.gz: a8ec4da3066f7c301611783c89f0a127f6c8ad4e7cf2467db9fe9071b7e0f943
+  data.tar.gz: 10fc3f33082886e7ca47e1ea97bd50075ffb15afbb91e1b309d9a12168a590ac
 SHA512:
-  metadata.gz: c60016fdfb41208d18ab63e36fb24a26c5a4cbc73978d44bab657ffb4ee8395d9c774311a752ae91e474b36d3b11d9eafb0c5ce1f54d8202068057d50b6c1093
-  data.tar.gz: 24656d7407eeea1ae1f92a8748eee1e65cdba4bafb9409ca0a96a819cfe7e3e2be4d9838fa3369464ccf908d5a7313de884a2e11c750f23664d88fcaa157f3dd
+  metadata.gz: 91e896c14c04e2135468d70031721cfbb29ba873284160f208315025bacc331a0fefaa04c837467d33b284253a04267ee8f4c003ea564770d619f9365ecb1b73
+  data.tar.gz: 03c6e84729ce4a4e6809cf53b92a6bcfb48572f1b8724e83cc451e829d1357b93da286e8fd6c669ddce3aa946cb0890237008992b9230e8cf41991e291fb8f76

data/CHANGELOG.md

@@ -5,6 +5,30 @@
 
 # Change Log
 
+## [5.6.1](https://github.com/ruby-git/ruby-git/compare/v5.6.0...v5.6.1) (2026-09-16)
+
+
+### Other Changes
+
+* **errors:** Document that filesystem and gzip errors can escape unconverted ([0b171e4](https://github.com/ruby-git/ruby-git/commit/0b171e42713a884354a84138696102f8e3cd83e5)), closes [#1809](https://github.com/ruby-git/ruby-git/issues/1809)
+* **remote:** Correct the argument forms in the Git::Remote and Git::Branch entries ([cea622a](https://github.com/ruby-git/ruby-git/commit/cea622a14cce54a90c2203953a457b13b298aa22)), closes [#1852](https://github.com/ruby-git/ruby-git/issues/1852)
+* **tag:** Note that tag_create raises UnexpectedResultError in v6.0.0 ([050aa44](https://github.com/ruby-git/ruby-git/commit/050aa443136156d7ecab47ad6fb44f436d9c2b7f)), closes [#1856](https://github.com/ruby-git/ruby-git/issues/1856)
+* **worktree:** Look the new worktree up with File.identical? in the v5.x note ([0c941ec](https://github.com/ruby-git/ruby-git/commit/0c941ec34204ef5c3aeb6cf1de9e61f33212a0d9))
+* **worktree:** Look the new worktree up with File.identical? in the YARD note ([8eb10ec](https://github.com/ruby-git/ruby-git/commit/8eb10eccb50ff14911e09033cfeec33666ce5c6a)), closes [#1845](https://github.com/ruby-git/ruby-git/issues/1845)
+* **worktree:** Note that worktree_add returns Git::WorktreeInfo in v6.0.0 ([24af07e](https://github.com/ruby-git/ruby-git/commit/24af07e24199303727d823804063732fcaa98c98)), closes [#1845](https://github.com/ruby-git/ruby-git/issues/1845)
+
+## [5.6.0](https://github.com/ruby-git/ruby-git/compare/v5.5.0...v5.6.0) (2026-09-12)
+
+
+### Features
+
+* **repository:** Deprecate with_* context helper blocks that declare no parameter ([231b65c](https://github.com/ruby-git/ruby-git/commit/231b65c435e9b3d9cdbf8b113b3aba9313da5110)), closes [#1835](https://github.com/ruby-git/ruby-git/issues/1835)
+
+
+### Other Changes
+
+* **export:** Describe what a failed .git removal leaves behind ([bd08096](https://github.com/ruby-git/ruby-git/commit/bd080964e44a11594202726e3823a8cafad62bd5)), closes [#1823](https://github.com/ruby-git/ruby-git/issues/1823)
+
 ## [5.5.0](https://github.com/ruby-git/ruby-git/compare/v5.4.1...v5.5.0) (2026-09-10)
 
 

data/README.md

@@ -201,11 +201,41 @@ the full API of its result.
 
 ## Errors raised by this gem
 
-The git gem raises only `ArgumentError` or errors that subclass `Git::Error`. It
-does not explicitly raise any other types of errors.
-
-Rescue `Git::Error` to catch any runtime error raised by this gem, unless you need
-more specific error handling.
+Errors the git gem raises deliberately are either `ArgumentError` or a subclass of
+`Git::Error`, with one exception: with the `raise` behavior described under
+[Deprecations](#deprecations), a deprecated call raises
+`ActiveSupport::DeprecationException`, which is intentionally not a `Git::Error` so a
+broad rescue cannot hide a deprecation your code opted to treat as fatal. The errors
+described below come from Ruby's standard library and are not converted.
+
+The gem's own filesystem operations, such as reading a `.git` pointer file,
+creating a temporary file, or changing directory, do not convert operating system
+errors. These can be raised as a bare `SystemCallError` (for example `Errno::ENOENT`
+or `Errno::EACCES`) rather than `Git::Error`. Gzip compression in `archive` can
+likewise raise a `Zlib::Error`. Rescue `SystemCallError` and `Zlib::Error` alongside
+`Git::Error` if your code needs to handle them.
+
+The affected methods are `Git.open` when the `.git` file is a gitdir pointer or the
+path is relative, `Git.init`, `Git.bare`, and `Git.clone` when the path is relative,
+`Git.export`, and these `Git::Repository` methods: `#chdir`, `#with_index`,
+`#with_working`, `#with_temp_index`, `#with_temp_working`, `#set_index`,
+`#set_working`, `#cat_file_contents` in block form, `#each_conflict`, `#conflicts`,
+`#archive` (including the gzip step), `#repo_size`, and `#tag_sha` when it reads a
+loose ref.
+
+Any method that captures git output can also raise
+`Encoding::ConverterNotFoundError` when the output contains a line whose detected
+encoding, such as UTF-7, has no Ruby converter.
+
+Starting with v6.0.0, the filesystem and gzip errors are raised as `Git::Error`
+with the original error available through `cause`, except that `#tag_sha` falls
+back to `git show-ref` instead of raising. Lines with no Ruby converter are
+scrubbed instead of raising.
+
+Rescue `Git::Error` to catch the runtime errors this gem raises itself, and add
+`SystemCallError`, `Zlib::Error`, and `Encoding::ConverterNotFoundError` where the
+paragraphs above say they can escape. Rescue a more specific subclass when you need
+finer-grained handling.
 
 ```ruby
 begin

data/UPGRADING.md

@@ -35,6 +35,7 @@ to update your code when upgrading from the preceding major version.
     - [`Git::Log` Enumerable interface deprecated](#gitlog-enumerable-interface-deprecated)
     - [`Git::Object::Commit#set_commit` deprecated](#gitobjectcommitset_commit-deprecated)
     - [`Git.export` `:remote` option deprecated](#gitexport-remote-option-deprecated)
+    - [Context helper blocks that declare no parameter deprecated](#context-helper-blocks-that-declare-no-parameter-deprecated)
 
 ## Upgrading to v6.0.0
 
@@ -636,7 +637,8 @@ with N remotes produces N + 1 warnings per call.
 > the last one configured, so use `r.url.last` to reproduce that exact value.
 > Likewise, `Git::Remote#fetch_opts` returned only the last configured fetch
 > refspec, while `fetch` holds all of them. Operations that lived on
-> `Git::Remote` are called on the repository with the remote name instead.
+> `Git::Remote` are called on the repository instead; the table below shows
+> the argument each one takes.
 >
 > **Order change:** `remotes` lists remotes in the order `git remote` prints
 > them, while `remote_list` keeps the order in which remotes first appear in the
@@ -655,8 +657,8 @@ with N remotes produces N + 1 warnings per call.
 | `remote.fetch(opts)` | `g.fetch(remote.name, opts)` — same options hash |
 | `remote.merge` | `g.merge("#{remote.name}/#{g.current_branch}")` |
 | `remote.merge(branch)` | `g.merge("#{remote.name}/#{branch}")` |
-| `remote.branch` | `g.branch_list("#{remote.name}/#{g.current_branch}").first` — returns a `Git::BranchInfo` |
-| `remote.branch(name)` | `g.branch_list("#{remote.name}/#{name}").first` — returns a `Git::BranchInfo` |
+| `remote.branch` | `g.branch_list("#{remote.name}/#{g.current_branch}").find(&:remote?)` — returns a `Git::BranchInfo` |
+| `remote.branch(name)` | `g.branch_list("#{remote.name}/#{name}").find(&:remote?)` — returns a `Git::BranchInfo` |
 | `remote.remove` | `g.remote_remove(remote.name)` |
 
 #### `Git::Remote` deprecated
@@ -664,13 +666,13 @@ with N remotes produces N + 1 warnings per call.
 `Git::Remote`, `Git::Repository#remote`, and `Git::Repository#config_remote` are
 deprecated and are removed in v6.0.0. Read a remote's configuration through
 `Git::Repository#remote_list`, which returns one `Git::RemoteInfo` value object per
-remote, and call the repository-level operations (`fetch`, `merge`, `branch_list`,
-`remote_remove`) with the remote name. Return values are unchanged. Constructing a
-`Git::Remote` directly emits one deprecation warning, and so does calling
-`g.config_remote`. Calling `g.remote` emits two: one for `Git::Repository#remote`
-and one for the `Git::Remote` it constructs. Likewise `g.remotes` emits one warning
-for itself plus one per `Git::Remote` it returns (N + 1 for N remotes). The extra
-warnings from `g.remote` and `g.remotes` are expected, not a bug.
+remote; the table below shows the replacement for each operation. Return values
+are unchanged. Constructing a `Git::Remote` directly emits one deprecation warning,
+and so does calling `g.config_remote`. Calling `g.remote` emits two: one for
+`Git::Repository#remote` and one for the `Git::Remote` it constructs. Likewise
+`g.remotes` emits one warning for itself plus one per `Git::Remote` it returns
+(N + 1 for N remotes). The extra warnings from `g.remote` and `g.remotes` are
+expected, not a bug.
 
 > **Return type changes:** `Git::RemoteInfo#url` and `Git::RemoteInfo#fetch` are
 > frozen `Array<String>` because a remote may carry more than one URL or fetch
@@ -685,8 +687,9 @@ warnings from `g.remote` and `g.remotes` are expected, not a bug.
 > Code that reads custom keys should filter `g.config_list` instead (see the
 > table); that yields the same `Hash{String => String}` as `config_remote`.
 > `Git::Remote#branch` returned a `Git::Branch`. Its replacement,
-> `g.branch_list("#{name}/#{branch}").first`, returns a `Git::BranchInfo` value
-> object, or `nil` when the remote-tracking branch does not exist.
+> `g.branch_list("#{name}/#{branch}").find(&:remote?)`, returns a
+> `Git::BranchInfo` value object, or `nil` when the remote-tracking branch does
+> not exist.
 
 In the table, `name` is the remote name (`g.remote` defaults it to `'origin'`).
 
@@ -703,8 +706,8 @@ In the table, `name` is the remote name (`g.remote` defaults it to `'origin'`).
 | `remote.fetch(opts)` | `g.fetch(name, opts)` — same option keys |
 | `remote.merge` | `g.merge("#{name}/#{g.current_branch}")` |
 | `remote.merge(branch)` | `g.merge("#{name}/#{branch}")` |
-| `remote.branch` | `g.branch_list("#{name}/#{g.current_branch}").first` — returns a `Git::BranchInfo` |
-| `remote.branch(branch)` | `g.branch_list("#{name}/#{branch}").first` — returns a `Git::BranchInfo` |
+| `remote.branch` | `g.branch_list("#{name}/#{g.current_branch}").find(&:remote?)` — returns a `Git::BranchInfo` |
+| `remote.branch(branch)` | `g.branch_list("#{name}/#{branch}").find(&:remote?)` — returns a `Git::BranchInfo` |
 | `remote.remove` | `g.remote_remove(name)` |
 
 #### `Git::Commands::CatFile::Raw` `allow_unknown_type` option deprecated
@@ -734,10 +737,12 @@ that constructs the command class directly is affected.
 data through `Git::Repository#branch_list`, which returns one `Git::BranchInfo`
 value object per local and remote-tracking branch, and call the repository-level
 operations (`checkout`, `branch_new`, `branch_delete`, `merge`, `merge_into`,
-`in_branch`, and so on) with the branch name. Calling `g.branch` or `g.branches`,
-constructing a `Git::Branches`, and calling any operation on a `Git::Branch` each
-emit a deprecation warning; their return values are unchanged. The `full`,
-`name`, `remote`, `to_s`, and `to_a` readers on `Git::Branch` do not warn.
+`in_branch`, and so on) with the branch name. For a remote-tracking branch the
+argument differs by operation; the table below shows the form each one takes.
+Calling `g.branch` or `g.branches`, constructing a `Git::Branches`, and calling
+any operation on a `Git::Branch` each emit a deprecation warning; their return
+values are unchanged. The `full`, `name`, `remote`, `to_s`, and `to_a` readers
+on `Git::Branch` do not warn.
 
 > **Return shape change:** `Git::Branch` exposes `full` (`main` or
 > `remotes/origin/main`), `name`, and `remote` (a `Git::Remote`, or `nil`).
@@ -862,6 +867,13 @@ warn.
 > **Missing tags:** `g.tag(name)` raises `Git::UnexpectedResultError` when no tag
 > has that name. `g.tag_list(name).first` returns `nil`.
 >
+> **`tag_create` when the new tag is missing in v6.0.0:** on v5.x, `g.tag_create`
+> returns `nil` when the tag it has just created is missing from the tag list
+> (for example, another process deleted it before the lookup). In v6.0.0 it
+> raises `Git::UnexpectedResultError` instead, so its return value is always a
+> `Git::TagInfo`. A `nil` check on the result keeps working today and becomes
+> unreachable in v6.0.0.
+>
 > **Deleting through `tag_add`:** `g.tag_add(name, d: true)`, which was already
 > deprecated, deletes the tag and emits a second warning pointing at
 > `g.tag_delete`. `g.tag_create` rejects `:d` and `:delete` with `ArgumentError`.
@@ -1008,7 +1020,7 @@ and are removed in v6.0.0. Read worktree data through
 object per worktree, and call the repository-level operations (`worktree_add`,
 `worktree_remove`, `worktree_move`, `worktree_lock`, `worktree_unlock`,
 `worktree_repair`, and `worktree_prune`) with the worktree path or its
-`Git::WorktreeInfo`. Return values are unchanged. Calling `g.worktree`,
+`Git::WorktreeInfo`. Return values are unchanged on v5.x. Calling `g.worktree`,
 `g.worktrees`, or `g.worktrees_all`, constructing a `Git::Worktrees`, and calling
 `gcommit`, `add`, or `remove` on a `Git::Worktree` each emit a deprecation
 warning; the `dir`, `full`, `to_s`, and `to_a` readers on `Git::Worktree` do not.
@@ -1034,6 +1046,14 @@ it constructs, and `g.worktree(dir).add` emits one for `g.worktree` and one for
 > **`full` and `to_s`:** `Git::Worktree#full` and `#to_s` append the commitish
 > given at construction to the path, so entries from `g.worktrees` read
 > `"/path/to/wt <sha>"`. `Git::WorktreeInfo#to_s` is the path alone.
+>
+> **`worktree_add` return type in v6.0.0:** on v5.x, `worktree_add` returns the
+> `git worktree add` output (`"HEAD is now at …"`). In v6.0.0 it returns the new
+> `Git::WorktreeInfo` instead. To get the entry today, look it up after the add:
+> `g.worktree_list.find { |w| File.identical?(w.path, dir) }`. Compare with
+> `File.identical?`, not string equality: git stores worktree paths with
+> symlinks resolved, so `/tmp/...` on macOS is listed as `/private/tmp/...`,
+> and on case-insensitive filesystems the listed casing may differ from `dir`.
 
 In the table, `dir` is the worktree path, `wt` is a `Git::Worktree`, and `info`
 is the `Git::WorktreeInfo` that replaces it.
@@ -1135,4 +1155,40 @@ observable in the result. Delete the option from the call.
 |--------------------------------------------------------------------|-------------|
 | `Git.export(url, dir, remote: name)` | `Git.export(url, dir)` |
 
+#### Context helper blocks that declare no parameter deprecated
+
+`Git::Repository#with_index`, `#with_temp_index`, `#with_working`, and
+`#with_temp_working` yield `self` in v5.x, so a block could ignore the yielded
+value and call methods on the receiver. Calling one of these helpers with a block
+that declares no positional parameter (`do ... end`, `{ }`, `{ || }`, or a block
+with only keyword or block parameters) now emits a deprecation warning. The
+behavior is otherwise unchanged: the helpers still yield `self`, and a call with
+no block still raises `LocalJumpError`.
+
+In v6.0.0 these helpers yield a separate repository bound to the other index or
+working tree instead of rebinding the receiver, and they raise `ArgumentError` for
+a block that declares no positional parameter. A call with no block also raises
+`ArgumentError` in v6.0.0 instead of `LocalJumpError`. Declare a block parameter
+and call methods on it. The parameter is required even when the block never uses
+the repository, for example a `with_temp_working` block that only writes files
+(`do |_scratch|`). Blocks that already declare a positional parameter (`|repo|`,
+`|_|`, `|repo = nil|`, `|*args|`, or a symbol-to-proc such as `&:write_tree`) do
+not warn. Both versions read the block's parameter list rather than its arity, so
+the v5.x warning and the v6.0.0 error agree on every block form.
+
+The warning detects only the block's parameter list. Adding an unused parameter
+(`|_|`) silences it but does not fix a block that still calls methods on the outer
+repository; that block does not warn and acts on the wrong repository in v6.0.0,
+so review those blocks by hand.
+
+| Deprecated call (works in v5.x, raises in v6.0.0) | Replacement |
+|---------------------------------------------------|-------------|
+| `g.with_index(path) { g.read_tree('HEAD') }` | `g.with_index(path) { \|r\| r.read_tree('HEAD') }` |
+| `g.with_temp_index { g.read_tree('HEAD') }` | `g.with_temp_index { \|r\| r.read_tree('HEAD') }` |
+| `g.with_working(dir) { g.add('.') }` | `g.with_working(dir) { \|r\| r.add('.') }` |
+| `g.with_temp_working { g.add('.') }` | `g.with_temp_working { \|r\| r.add('.') }` |
+
+`chdir` is not part of this deprecation. It yields the directory path in both
+versions.
+
 ---

data/lib/git/errors.rb

@@ -5,8 +5,20 @@ module Git
 
   # Base class for all custom git module errors
   #
-  # The git gem will only raise an `ArgumentError` or an error that is a subclass of
-  # `Git::Error`. It does not explicitly raise any other types of errors.
+  # Errors the git gem raises deliberately are either `ArgumentError` or a subclass
+  # of `Git::Error`. The exceptions described below come from Ruby's standard
+  # library and are not converted.
+  #
+  # The gem's own filesystem operations, such as reading a `.git` pointer file,
+  # creating a temporary file, or changing directory, do not convert operating
+  # system errors. These can be raised as a bare `SystemCallError` (for example
+  # `Errno::ENOENT` or `Errno::EACCES`) rather than `Git::Error`. Gzip compression
+  # in `archive` can likewise raise a `Zlib::Error`. Rescue `SystemCallError` and
+  # `Zlib::Error` alongside `Git::Error` if your code needs to handle them. Any
+  # method that captures git output can also raise
+  # `Encoding::ConverterNotFoundError` when a line's detected encoding has no Ruby
+  # converter. See the "Errors raised by this gem" section of the README for the
+  # affected methods.
   #
   # It is recommended to rescue `Git::Error` to catch any runtime error raised by
   # this gem unless you need more specific error handling.

data/lib/git/repository/context_helpers.rb

@@ -18,6 +18,10 @@ module Git
     # @api private
     #
     module ContextHelpers
+      # Parameter types from `Proc#parameters` that receive a positional argument
+      CONTEXT_HELPERS_POSITIONAL_PARAMETERS = %i[req opt rest].freeze
+      private_constant :CONTEXT_HELPERS_POSITIONAL_PARAMETERS
+
       # Changes the current working directory to the repository working directory
       # for the duration of the block
       #
@@ -51,9 +55,13 @@ module Git
       # yields `self`, then unconditionally restores the original execution
       # context — even if the block raises an exception.
       #
+      # Deprecated form: a block that declares no positional parameter emits a
+      # deprecation warning, because v6.0.0 yields a separate repository
+      # instead of `self`.
+      #
       # @example Read a tree into a custom index
-      #   repo.with_index('/tmp/custom.index') do
-      #     repo.read_tree('HEAD')
+      #   repo.with_index('/tmp/custom.index') do |r|
+      #     r.read_tree('HEAD')
       #   end
       #
       # @param new_index [String, Pathname] path to the replacement index file
@@ -66,7 +74,8 @@ module Git
       #
       # @yieldreturn [Object] returned as the method's return value
       #
-      def with_index(new_index) # :yields: self
+      def with_index(new_index, &block) # :yields: self
+        context_helpers_warn_if_block_declares_no_parameter(:with_index, block)
         old_context = @execution_context
         set_index(new_index, must_exist: false)
         yield self
@@ -84,10 +93,14 @@ module Git
       # are removed unconditionally after the block exits, even if the block
       # raises an exception.
       #
+      # Deprecated form: a block that declares no positional parameter emits a
+      # deprecation warning, because v6.0.0 yields a separate repository
+      # instead of `self`.
+      #
       # @example Stage changes using a temporary index
-      #   repo.with_temp_index do
-      #     repo.read_tree('HEAD')
-      #     repo.write_tree
+      #   repo.with_temp_index do |r|
+      #     r.read_tree('HEAD')
+      #     r.write_tree
       #   end
       #
       # @return [Object] the value returned by the block
@@ -98,13 +111,17 @@ module Git
       #
       # @yieldreturn [Object] returned as the method's return value
       #
-      def with_temp_index(&) # :yields: self
+      def with_temp_index(&block) # :yields: self
+        context_helpers_warn_if_block_declares_no_parameter(:with_temp_index, block)
         # Use a unique temp directory so the index file path is collision-free
         # and does not exist until git writes it. An existing empty file would
         # be treated as a corrupt index by git.
         temp_dir = Dir.mktmpdir('git-temp-index-')
         begin
-          with_index(File.join(temp_dir, 'index'), &)
+          # The inner block declares a parameter so with_index does not warn a
+          # second time under its own name; forwarding &block would.
+          # rubocop:disable-next Style/ExplicitBlockArgument
+          with_index(File.join(temp_dir, 'index')) { |repo| yield repo }
         ensure
           FileUtils.remove_entry(temp_dir, true)
         end
@@ -118,10 +135,14 @@ module Git
       # `self`, then unconditionally restores the original execution context —
       # even if the block raises an exception.
       #
+      # Deprecated form: a block that declares no positional parameter emits a
+      # deprecation warning, because v6.0.0 yields a separate repository
+      # instead of `self`.
+      #
       # @example Commit changes from a different worktree path
-      #   repo.with_working('/path/to/worktree') do
-      #     repo.add('.')
-      #     repo.commit('chore: automated update')
+      #   repo.with_working('/path/to/worktree') do |r|
+      #     r.add('.')
+      #     r.commit('chore: automated update')
       #   end
       #
       # @param work_dir [String, Pathname] path to the replacement working
@@ -138,7 +159,8 @@ module Git
       #
       # @yieldreturn [Object] returned as the method's return value
       #
-      def with_working(work_dir) # :yields: self
+      def with_working(work_dir, &block) # :yields: self
+        context_helpers_warn_if_block_declares_no_parameter(:with_working, block)
         old_context = @execution_context
         set_working(work_dir)
         Dir.chdir(dir.to_s) { yield self }
@@ -153,9 +175,14 @@ module Git
       # The temporary directory is removed unconditionally after the block
       # exits, even if the block raises an exception.
       #
+      # Deprecated form: a block that declares no positional parameter emits a
+      # deprecation warning, because v6.0.0 yields a separate repository
+      # instead of `self`.
+      #
       # @example Write files in an isolated temporary working directory
-      #   repo.with_temp_working do
+      #   repo.with_temp_working do |r|
       #     File.write('scratch.txt', 'temporary content')
+      #     r.add('scratch.txt')
       #   end
       #
       # @return [Object] the value returned by the block
@@ -168,7 +195,11 @@ module Git
       # @yieldreturn [Object] returned as the method's return value
       #
       def with_temp_working(&block) # :yields: self
-        Dir.mktmpdir('temp-workdir') { |temp_dir| with_working(temp_dir, &block) }
+        context_helpers_warn_if_block_declares_no_parameter(:with_temp_working, block)
+        # The inner block declares a parameter so with_working does not warn a
+        # second time under its own name; forwarding &block would.
+        # rubocop:disable-next Style/ExplicitBlockArgument
+        Dir.mktmpdir('temp-workdir') { |temp_dir| with_working(temp_dir) { |repo| yield repo } }
       end
 
       # Sets the git index to `index_file` and rebuilds the execution context
@@ -231,6 +262,42 @@ module Git
 
       private
 
+      # Emits a deprecation warning when `block` declares no positional parameter
+      #
+      # In v6.0.0 the `with_*` helpers yield a separate repository instead of
+      # rebinding the receiver, so a block that calls methods on the receiver
+      # (the v5.x form) acts on the wrong repository there. v6.0.0 raises
+      # `ArgumentError` for that form using this same rule: the block must
+      # declare a required, optional, or splat positional parameter. The rule
+      # reads `Proc#parameters` rather than arity because an optional parameter
+      # gives a proc an arity of zero although it receives the repository,
+      # while keyword and block parameters cannot receive it.
+      #
+      # A missing block is not checked here; the helper's `yield` raises
+      # `LocalJumpError` as before.
+      #
+      # The warning reports the helper's caller, not this helper's caller, so
+      # the location points at the block that needs changing.
+      #
+      # @param helper [Symbol] the public helper name used in the warning
+      #
+      # @param block [Proc, nil] the block passed to the helper
+      #
+      # @return [void]
+      #
+      def context_helpers_warn_if_block_declares_no_parameter(helper, block)
+        return if block.nil?
+        return if block.parameters.any? { |type, _name| CONTEXT_HELPERS_POSITIONAL_PARAMETERS.include?(type) }
+
+        Git::Deprecation.warn(
+          "Calling Git::Repository##{helper} with a block that declares no positional " \
+          'parameter is deprecated and will be removed in v6.0.0, where the helper ' \
+          'yields a separate repository instead of self. Declare a block parameter and ' \
+          "call methods on it instead: #{helper} { |repo| repo.some_method }",
+          caller_locations(2)
+        )
+      end
+
       # Resolves deprecated `check` argument semantics with `must_exist:`
       #
       # @param check [Boolean, nil] deprecated positional existence-check value

data/lib/git/repository/object_operations.rb

@@ -928,7 +928,9 @@ module Git
       #   @option options [Boolean, nil] :create_reflog (nil) create a reflog for
       #     the tag
       #
-      #   @return [Git::TagInfo] the newly created tag
+      #   @return [Git::TagInfo, nil] the newly created tag, or `nil` when the tag
+      #     is missing from the tag list after the create (for example, another
+      #     process deleted it before the lookup)
       #
       # @overload tag_create(name, target, options = {})
       #
@@ -945,7 +947,9 @@ module Git
       #   @param options [Hash] options for creating the tag (same keys as the
       #     first overload)
       #
-      #   @return [Git::TagInfo] the newly created tag
+      #   @return [Git::TagInfo, nil] the newly created tag, or `nil` when the tag
+      #     is missing from the tag list after the create (for example, another
+      #     process deleted it before the lookup)
       #
       # @raise [ArgumentError] if unsupported options are provided, including the
       #   `:d` and `:delete` keys that {#tag_add} accepts; use {#tag_delete} to
@@ -960,6 +964,12 @@ module Git
       #
       # @raise [Git::FailedError] if git exits with a non-zero exit status
       #
+      # @note In v6.0.0 this method raises {Git::UnexpectedResultError} instead of
+      #   returning `nil` when the tag it has just created is missing from the tag
+      #   list, so its return value is always a {Git::TagInfo}. Code that checks
+      #   the result for `nil` today can be left as is; the check becomes
+      #   unreachable in v6.0.0.
+      #
       # @see https://git-scm.com/docs/git-tag git-tag
       #
       def tag_create(name, *args)

data/lib/git/repository/worktree_operations.rb

@@ -99,6 +99,14 @@ module Git
       #
       # @raise [Git::FailedError] if git exits with a non-zero exit status
       #
+      # @note In v6.0.0 this method returns the new {Git::WorktreeInfo} instead of
+      #   the command output. To get the entry today, look it up after the add:
+      #   `worktree_list.find { |w| File.identical?(w.path, dir) }`.
+      #   Compare with `File.identical?`, not string equality: git stores
+      #   worktree paths with symlinks resolved, so `/tmp/...` on macOS is
+      #   listed as `/private/tmp/...`, and on case-insensitive filesystems the
+      #   listed casing may differ from `dir`.
+      #
       # @see https://git-scm.com/docs/git-worktree git-worktree documentation
       #
       def worktree_add(dir, commitish = nil)

data/lib/git/version.rb

@@ -4,7 +4,7 @@ module Git
   # The current gem version
   #
   # @return [String] the current gem version
-  VERSION = '5.5.0'
+  VERSION = '5.6.1'
 
   # Represents a git version with major, minor, and patch components
   #

data/lib/git.rb

@@ -327,6 +327,11 @@ module Git
   # Exports the current HEAD (or the specific branch given in <tt>options[:branch]</tt>)
   # into the given `directory`. It then removes all traces of git from the directory.
   #
+  # Removing `.git` is not atomic. If it fails, the exported files are complete and
+  # usable, but the directory keeps whatever part of `.git` could not be deleted.
+  # Nothing is cleaned up, because the exported files are the deliverable and the
+  # leftover has to be removed by hand once the cause of the failure is fixed.
+  #
   # Takes the same options as {Git.clone} except that `:depth` defaults to 1 and
   # `:remote` is ignored with a deprecation warning.
   #
@@ -348,6 +353,10 @@ module Git
   #
   # @return [void]
   #
+  # @raise [SystemCallError] if the `.git` directory cannot be removed. The exported
+  #   files are left in place, and the directory keeps whatever part of `.git` could
+  #   not be deleted.
+  #
   def self.export(repository_url, directory = nil, options = {})
     if options.key?(:remote)
       Git::Deprecation.warn(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.6.1
 platform: ruby
 authors:
 - Scott Chacon and others
@@ -548,8 +548,8 @@ licenses:
 metadata:
   homepage_uri: http://github.com/ruby-git/ruby-git
   source_code_uri: http://github.com/ruby-git/ruby-git
-  changelog_uri: https://rubydoc.info/gems/git/5.5.0/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/5.5.0
+  changelog_uri: https://rubydoc.info/gems/git/5.6.1/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/5.6.1
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -566,7 +566,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - git 2.28.0 or greater
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: An API to create, read, and manipulate Git repositories
 test_files: []