git 5.6.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb847c9e15258e66f25f6856a2ceb170213e9ae310d061035ef23501e6e0cd72
-  data.tar.gz: eca3a73ec5bf9f979d4576375062ceaeb71a78b54f12660b3b4386c2920792e9
+  metadata.gz: a8ec4da3066f7c301611783c89f0a127f6c8ad4e7cf2467db9fe9071b7e0f943
+  data.tar.gz: 10fc3f33082886e7ca47e1ea97bd50075ffb15afbb91e1b309d9a12168a590ac
 SHA512:
-  metadata.gz: 3842eadabba8c7bead2147b438ca51597ca0acc129b7d33b41f942750d29cb7e5910b1ca92e3f50cf7bc440afb9f5ed203a97f38b72c19b09025f4e7317849f2
-  data.tar.gz: 558adf7d3f23639b9143dcf3b9092739caba6415e066a8273f491f0589f3af06851dc15fd1776b2bad3e406d01429da76cce72c7e05f3c7ac57858bc3a771645
+  metadata.gz: 91e896c14c04e2135468d70031721cfbb29ba873284160f208315025bacc331a0fefaa04c837467d33b284253a04267ee8f4c003ea564770d619f9365ecb1b73
+  data.tar.gz: 03c6e84729ce4a4e6809cf53b92a6bcfb48572f1b8724e83cc451e829d1357b93da286e8fd6c669ddce3aa946cb0890237008992b9230e8cf41991e291fb8f76

data/CHANGELOG.md

@@ -5,6 +5,18 @@
 
 # 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)
 
 

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

@@ -637,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
@@ -656,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
@@ -665,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
@@ -686,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'`).
 
@@ -704,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
@@ -735,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`).
@@ -863,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`.
@@ -1009,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.
@@ -1035,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.

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/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.6.0'
+  VERSION = '5.6.1'
 
   # Represents a git version with major, minor, and patch components
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 5.6.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.6.0/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/5.6.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: []