git 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b0ec11636ea561f0c879744f4c7b94fd12f2a2fae29da23ac22f338edefe9fe
-  data.tar.gz: b70d5290d89c34293b3dd47b839b1a6d091f7d081236623b844160269e07e2ae
+  metadata.gz: 8a27bcb58894e06dd36f368c545d7800e95b2106122d222f98e43e4776117d38
+  data.tar.gz: a59267db8db5a09e843914400be509c574670d824882b8c7a0c80f3e38945238
 SHA512:
-  metadata.gz: 449e637646f9faba003af92629c11dbf3a42703f4331a331c3bf03f218659335fd1abd17344bc74f91ffd78a9e4823c3f4dd6cb1ac9a2546a5884cd673dd2a47
-  data.tar.gz: f2a797c6f9a56ae2c877c01a3b7f3da3db46f5d82b5b930de44998035404255692a44c012efb610d4032e5b8d72231f782cf7e5ba921de344c94dde4c5c7b52a
+  metadata.gz: c60016fdfb41208d18ab63e36fb24a26c5a4cbc73978d44bab657ffb4ee8395d9c774311a752ae91e474b36d3b11d9eafb0c5ce1f54d8202068057d50b6c1093
+  data.tar.gz: 24656d7407eeea1ae1f92a8748eee1e65cdba4bafb9409ca0a96a819cfe7e3e2be4d9838fa3369464ccf908d5a7313de884a2e11c750f23664d88fcaa157f3dd

data/CHANGELOG.md

@@ -5,6 +5,37 @@
 
 # Change Log
 
+## [5.5.0](https://github.com/ruby-git/ruby-git/compare/v5.4.1...v5.5.0) (2026-09-10)
+
+
+### Features
+
+* **export:** Warn when the :remote option is passed to Git.export ([55a9810](https://github.com/ruby-git/ruby-git/commit/55a9810b7681a510781e55b17026ec6e13dcbfa5)), closes [#1820](https://github.com/ruby-git/ruby-git/issues/1820)
+
+
+### Bug Fixes
+
+* **export:** Drop the redundant checkout that broke Git.export for tags ([5e8422d](https://github.com/ruby-git/ruby-git/commit/5e8422d2361bff43959a0bba2254118087907a2a)), closes [#1815](https://github.com/ruby-git/ruby-git/issues/1815)
+
+
+### Other Changes
+
+* **export:** Document the deprecated :remote option to Git.export ([3806d2b](https://github.com/ruby-git/ruby-git/commit/3806d2b5a6fdb167006097df83c783573024a521)), closes [#1820](https://github.com/ruby-git/ruby-git/issues/1820)
+* Name the 5.x maintenance branch alongside 4.x ([ad30718](https://github.com/ruby-git/ruby-git/commit/ad30718a61cb89c343c84c71feb1c94cf3995f28))
+* Run the CI, commitlint, release, and cache workflows for the 5.x branch ([7c3fd13](https://github.com/ruby-git/ruby-git/commit/7c3fd13994104c2c6b6564cc41d1e3c4e614255a))
+
+## [5.4.1](https://github.com/ruby-git/ruby-git/compare/v5.4.0...v5.4.1) (2026-09-04)
+
+
+### Other Changes
+
+* Document the Git.clone option renames in UPGRADING.md ([0f8e5d8](https://github.com/ruby-git/ruby-git/commit/0f8e5d85eda89d2da802eebde5036c3f32b0f08e)), closes [#1763](https://github.com/ruby-git/ruby-git/issues/1763)
+* **upgrading:** Document the Git::Log Enumerable and Commit#set_commit deprecations ([1d1c9bc](https://github.com/ruby-git/ruby-git/commit/1d1c9bcf33824ced13b13d61f7ce2f4cb1169e8d)), closes [#1764](https://github.com/ruby-git/ruby-git/issues/1764)
+* **upgrading:** Document the Git::Repository method renames ([e1bb6e6](https://github.com/ruby-git/ruby-git/commit/e1bb6e6214340fed5b52acf0366488c860687f41)), closes [#1765](https://github.com/ruby-git/ruby-git/issues/1765)
+* **upgrading:** Document the Git::Repository option renames ([0a2dfcb](https://github.com/ruby-git/ruby-git/commit/0a2dfcba94d9b5a0e89bdeaa9ec32de3ddc6dc59)), closes [#1766](https://github.com/ruby-git/ruby-git/issues/1766)
+* **upgrading:** Document the module-level Git deprecations ([cd3a2ae](https://github.com/ruby-git/ruby-git/commit/cd3a2ae81af6f90bf9e65b3ac21bce722efd84fc)), closes [#1762](https://github.com/ruby-git/ruby-git/issues/1762)
+* **upgrading:** Remove two misplaced rows from the configuration methods table ([61ad4c8](https://github.com/ruby-git/ruby-git/commit/61ad4c85763b1695618378b27d5f51e28bd0369d)), closes [#1761](https://github.com/ruby-git/ruby-git/issues/1761)
+
 ## [5.4.0](https://github.com/ruby-git/ruby-git/compare/v5.3.0...v5.4.0) (2026-09-04)
 
 

data/CONTRIBUTING.md

@@ -128,7 +128,7 @@ bin/setup
 3. Run `npm install` (when npm is available) to install the Conventional Commit
    `commit-msg` hook used by this project (Husky + commitlint). A separate
    `pre-commit` hook is also installed that blocks direct commits to the
-   protected branches (`main`, `4.x`).
+   protected branches (`main`, `5.x`, `4.x`).
 4. Verify the toolchain by running `bundle exec rake --tasks`.
 
 `bin/setup` checks for [lychee](https://lychee.cli.rs) alongside Ruby, git, and
@@ -197,7 +197,7 @@ Once your pull request is ready for review, request a review from at least one
 
 During the review process, you may need to make additional commits; squash them.
 You will also need to rebase your branch onto the latest version of the target
-branch (e.g., `main` or `4.x`) before merging.
+branch (e.g., `main`, `5.x`, or `4.x`) before merging.
 
 At least one approval from a project maintainer is required before your pull request
 can be merged. The maintainer is responsible for ensuring that the pull request meets
@@ -219,11 +219,13 @@ first keeps the review cycle short.
 
 ## Branch strategy
 
-This project maintains two active branches:
+This project maintains `main` plus one maintenance branch for each supported previous
+major series:
 
 - **`main`**: All development. It releases the next version of the gem, including
-  the next major version.
-- **`4.x`**: The maintenance branch for the most recent previous major series. It
+  the next major version. Its next release is v6.0.0; every further v5.x release is
+  cut from `5.x`.
+- **`5.x`** and **`4.x`**: The maintenance branches for the v5.x and v4.x series. Each
   receives bug fixes and security fixes, and backward-compatible features at the
   maintainers' discretion.
 
@@ -233,8 +235,10 @@ each major series is supported.
 When submitting a pull request:
 
 - **New features and breaking changes**: Target the `main` branch
-- **Bug fixes**: Target `main`, and maintainers will backport to `4.x` if applicable
-- **Security fixes**: Target both branches or `4.x` if the issue only affects v4.x
+- **Bug fixes**: Target `main`, and maintainers will backport to the maintenance
+  branches if applicable
+- **Security fixes**: Target `main` and every affected maintenance branch, or only a
+  maintenance branch if the issue affects that series alone
 
 Removing a deprecated API follows the
 [deprecation policy](.github/skills/breaking-change-analysis/SKILL.md#step-4-deprecation-policy):
@@ -981,9 +985,9 @@ skill. Follow it when writing or reviewing specs under `spec/unit/`.
 
 #### Test coverage policy
 
-**Every pull request to `main` must keep `bundle exec rake spec:unit` at 100% line
-coverage and 100% branch coverage of `lib/`.** CI fails the build when it drops
-below either threshold.
+**Every pull request to `main` or `5.x` must keep `bundle exec rake spec:unit` at
+100% line coverage and 100% branch coverage of `lib/`.** CI fails the build when it
+drops below either threshold.
 
 This is enforceable without being onerous because unit coverage in this project is
 deterministic: `lib/` has no Ruby-version, Ruby-engine, or platform conditionals, and
@@ -1088,8 +1092,8 @@ $ LIST_UNCOVERED_DETAIL=true bundle exec rake spec:unit
 $ open coverage/index.html
 ```
 
-This policy applies to `main` only. The `4.x` maintenance branch predates it and is
-not held to these thresholds.
+This policy applies to `main` and `5.x`. The `4.x` maintenance branch predates it and
+is not held to these thresholds.
 
 #### Unit tests vs integration tests
 

data/README.md

@@ -447,12 +447,13 @@ are in [UPGRADING.md](UPGRADING.md#upgrading-to-v600). See
 ### Release support policy
 
 All development happens on `main`, which releases the next version of the gem,
-including the next major version.
+including the next major version. The next release from `main` is v6.0.0. Every
+further v5.x release is cut from `5.x`.
 
-The most recent previous major series is maintained on a branch named for that
-series, currently `4.x`. It receives bug fixes and security fixes, and
-backward-compatible features at the maintainers' discretion. Fixes land on `main`
-first and are backported, except a fix for a problem that exists only in the
+Each supported previous major series is maintained on a branch named for that
+series, currently `5.x` and `4.x`. These branches receive bug fixes and security
+fixes, and backward-compatible features at the maintainers' discretion. Fixes land on
+`main` first and are backported, except a fix for a problem that exists only in a
 maintenance branch, which targets that branch directly.
 
 Support for a major series ends when the second major after it is released. v4.x is

data/UPGRADING.md

@@ -16,8 +16,11 @@ to update your code when upgrading from the preceding major version.
     - [`Git::CommandLineResult` deprecated](#gitcommandlineresult-deprecated)
   - [Deprecated methods](#deprecated-methods)
     - [Facade method renames](#facade-method-renames)
+    - [`Git::Repository` method renames](#gitrepository-method-renames)
+    - [`Git::Repository` option renames](#gitrepository-option-renames)
     - [v4.x-style configuration methods](#v4x-style-configuration-methods)
     - [`Git` module mixin deprecations](#git-module-mixin-deprecations)
+    - [Module-level `Git` function deprecations](#module-level-git-function-deprecations)
     - [`Git::Author` deprecated](#gitauthor-deprecated)
     - [`Git::Branch#stashes` deprecated](#gitbranchstashes-deprecated)
     - [Legacy stash API deprecated](#legacy-stash-api-deprecated)
@@ -28,6 +31,10 @@ to update your code when upgrading from the preceding major version.
     - [`Git::Object::Tag` deprecated](#gitobjecttag-deprecated)
     - [`Git::Status` deprecated](#gitstatus-deprecated)
     - [`Git::Worktree` and `Git::Worktrees` deprecated](#gitworktree-and-gitworktrees-deprecated)
+    - [`Git.clone` option renames](#gitclone-option-renames)
+    - [`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)
 
 ## Upgrading to v6.0.0
 
@@ -354,18 +361,89 @@ The old names continue to work but emit deprecation warnings:
 | `g.add_tag(name, ...)` | `g.tag_add(name, ...)` |
 | `g.delete_tag(name)` | `g.tag_delete(name)` |
 
+#### `Git::Repository` method renames
+
+Seven more `Git::Repository` methods were renamed in v5.x. The old names continue
+to work but emit deprecation warnings. Each old name returns exactly what its
+replacement returns, except `branches_all`.
+
+> **Return shape change:** `g.branches_all` returns an `Array` of 4-element
+> tuples `[refname, current, worktree, symref]`, where `refname` is the short
+> form (`main` or `remotes/origin/main`), `current` and `worktree` are booleans,
+> and `symref` is the symbolic-ref target or `nil`. `g.branch_list` returns
+> `Array<Git::BranchInfo>` with `refname` (always the full ref: `refs/heads/main`
+> or `refs/remotes/origin/main`), `short_name`, `remote_name`, `remote?`,
+> `current?`, `other_worktree?`, `symref`, `target_oid`, and `upstream`. This
+> expression reproduces the legacy tuples:
+>
+> ```ruby
+> g.branch_list.map do |i|
+>   refname = i.remote? ? "remotes/#{i.remote_name}/#{i.short_name}" : i.short_name
+>   [refname, i.current?, i.other_worktree?, i.symref]
+> end
+> ```
+
+| Deprecated call (works in v5.x, removed in v6.0.0) | Replacement |
+|-----------------------------------------------------|-------------|
+| `g.empty?` | `g.no_commits?` — `true` when the repository has no commits |
+| `g.reset_hard` | `g.reset(nil, hard: true)` — `reset` takes the commitish positionally, so pass `nil` before the options; returns git's stdout, as `reset_hard` did |
+| `g.reset_hard(commitish)` | `g.reset(commitish, hard: true)` — `reset_hard` ignored any `:hard` option passed to it and always reset with `--hard` |
+| `g.conflicts { \|file, yours, theirs\| ... }` | `g.each_conflict { \|file, yours, theirs\| ... }` — same block arguments; returns the unmerged paths |
+| `g.is_local_branch?(name)` | `g.local_branch?(name)` |
+| `g.is_remote_branch?(name)` | `g.remote_branch?(name)` |
+| `g.is_branch?(name)` | `g.branch?(name)` |
+| `g.branches_all` | `g.branch_list` — returns `Array<Git::BranchInfo>`; see the return shape change above |
+
+#### `Git::Repository` option renames
+
+Five methods accept a v4.x option or positional argument under its old name.
+The old form still works in v5.x but emits a deprecation warning and is
+translated to the v5.x form shown below.
+
+> **`clean`:** `force: 2` runs `git clean -ff`, which also removes untracked
+> nested git repositories. A `false` or `nil` value for `:ff` or `:force_force`
+> still warns and has no effect; a value other than `true`, `false`, or `nil`
+> raises `ArgumentError`. When the deprecated key is `true` and a valid
+> `:force` is also given, `:force` is raised to `2` (a `:force` already at `2`
+> is unchanged). An invalid `:force` value such as `0` is passed through
+> unchanged and still raises `ArgumentError`; the deprecated key does not mask
+> it.
+
+> **`diff_path_status`:** `:path_limiter` accepts the same values as `:path`
+> (a `String`, a `Pathname`, or an `Array` of them). When both keys are given,
+> `:path_limiter` wins and no warning is emitted.
+
+> **`set_working` and `set_index`:** `must_exist:` defaults to `true`. When
+> both the positional argument and `must_exist:` are given, they are OR'ed so
+> the more restrictive value wins.
+
+| Deprecated call (works in v5.x, removed in v6.0.0) | Replacement |
+|-----------------------------------------------------|-------------|
+| `g.clean(ff: true)` | `g.clean(force: 2)` |
+| `g.clean(force_force: true)` | `g.clean(force: 2)` |
+| `g.diff_path_status(ref1, ref2, path: p)` | `g.diff_path_status(ref1, ref2, path_limiter: p)` |
+| `g.commit(message, add_all: true)` | `g.commit(message, all: true)` — runs `git commit -a` |
+| `g.set_working(dir, check)` | `g.set_working(dir, must_exist: check)` |
+| `g.set_index(file, check)` | `g.set_index(file, must_exist: check)` |
+
 #### v4.x-style configuration methods
 
 The v4.x `config` and `global_config` methods accepted varying argument shapes
 to read, write, or list configuration. These are replaced by separate,
-purpose-named methods.
-
-> **Return type change:** The v4.x `g.config(name)` returned a `String` and
-> `g.config` returned a `Hash`. The v5.x replacements `config_get` and
-> `config_list` return `Git::ConfigEntryInfo` and `Array<Git::ConfigEntryInfo>`
+purpose-named methods. The same applies to the module-level
+`Git.global_config`, which is replaced by `Git.config_get`, `Git.config_set`,
+and `Git.config_list` called with `global: true`.
+
+> **Return type change:** The v4.x `g.config(name)` and `Git.global_config(name)`
+> returned a `String`; `g.config` and `Git.global_config` returned a `Hash`. The
+> v5.x replacements `config_get` and `config_list` return `Git::ConfigEntryInfo`
+> (or `nil` when the key is not set) and `Array<Git::ConfigEntryInfo>`
 > respectively. Use `.value` to get the String value:
 > - `g.config_get(name)&.value` → String or nil
 > - `g.config_list.to_h { |e| [e.key, e.value] }` → Hash (key → value)
+>
+> The setters `g.config(name, value)` and `Git.global_config(name, value)`
+> returned the raw command result; `config_set` returns `nil`.
 
 | Deprecated call (works in v5.x, removed in v6.0.0) | Replacement |
 |-----------------------------------------------------|-------------|
@@ -375,8 +453,9 @@ purpose-named methods.
 | `g.global_config(name)` | `g.config_get(name, global: true)` |
 | `g.global_config` | `g.config_list(global: true)` |
 | `g.global_config(name, value)` | `g.config_set(name, value, global: true)` |
-| `g.parse_config(file)` | `g.config_list(file: file)` |
-| `g.stash_list` | `g.stash_infos` — returns `Array<Git::StashInfo>`; see [Legacy stash API deprecated](#legacy-stash-api-deprecated) |
+| `Git.global_config(name)` | `Git.config_get(name, global: true)` — returns `Git::ConfigEntryInfo` or `nil`; use `.value` for the String |
+| `Git.global_config` | `Git.config_list(global: true)` — returns `Array<Git::ConfigEntryInfo>` |
+| `Git.global_config(name, value)` | `Git.config_set(name, value, global: true)` |
 
 #### `Git` module mixin deprecations
 
@@ -385,13 +464,43 @@ as bare methods is deprecated:
 
 | Deprecated usage | Replacement |
 |-----------------|-------------|
-| `include Git; config(name)` | `Git.open(Dir.pwd).config_get(name)` |
-| `include Git; config(name, value)` | `Git.open(Dir.pwd).config_set(name, value)` |
-| `include Git; config` | `Git.open(Dir.pwd).config_list` |
+| `include Git; config(name)` | `Git.config_get(name)` |
+| `include Git; config(name, value)` | `Git.config_set(name, value)` |
+| `include Git; config` | `Git.config_list` |
 | `include Git; global_config(name)` | `Git.config_get(name, global: true)` |
 | `include Git; global_config(name, value)` | `Git.config_set(name, value, global: true)` |
 | `include Git; global_config` | `Git.config_list(global: true)` |
 
+`Git.config_get`, `Git.config_set`, and `Git.config_list` run `git config` in
+the current directory, which is what the mixin `config` method did. The
+return types differ as described under
+[v4.x-style configuration methods](#v4x-style-configuration-methods).
+
+#### Module-level `Git` function deprecations
+
+Two module-level functions on `Git` accept a legacy call shape or return a
+legacy type that is deprecated:
+
+- `Git.ls_remote` defaults its repository argument to `'.'`. Passing `nil`
+  explicitly still works but warns; omit the argument or pass `'.'`. The
+  options hash is positional, so when you pass options you must also pass the
+  repository: `Git.ls_remote('.', opts)`, not `Git.ls_remote(opts)`.
+- `Git.binary_version` is replaced by `Git.git_version`, which keeps the
+  optional binary path argument.
+
+> **Return type change:** `Git.binary_version` returned an `Array<Integer>` of
+> `[major, minor, patch]`. `Git.git_version` returns a `Git::Version`, which
+> supports comparison and exposes `major`, `minor`, and `patch`.
+> `Git.git_version.to_a` reproduces the legacy array. The return value of
+> `Git.ls_remote` is unchanged.
+
+| Deprecated call (works in v5.x, removed in v6.0.0) | Replacement |
+|-----------------------------------------------------|-------------|
+| `Git.ls_remote(nil)` | `Git.ls_remote` or `Git.ls_remote('.')` |
+| `Git.ls_remote(nil, opts)` | `Git.ls_remote('.', opts)` |
+| `Git.binary_version` | `Git.git_version` — returns `Git::Version`; use `.to_a` for the `[major, minor, patch]` Array |
+| `Git.binary_version(binary_path)` | `Git.git_version(binary_path)` |
+
 #### `Git::Author` deprecated
 
 Starting in v5.3.0, methods that return author, committer, or tagger data —
@@ -946,4 +1055,84 @@ is the `Git::WorktreeInfo` that replaces it.
 | `wt.full`, `wt.to_s` | `info.path` — or `"#{info.path} #{info.head}"` for the descriptor that entries from `g.worktrees` produced |
 | `wt.to_a` | `[info.path]` |
 
+#### `Git.clone` option renames
+
+Three `Git.clone` options were renamed in v5.x. The v4.x names still work. Each
+deprecated option present on a call emits its own deprecation warning, so a call
+that uses two of them warns twice. Each value is passed through to the
+replacement option, except that `:path` is dropped when `:chdir` is also given.
+
+> **Precedence and value notes:**
+> - `:path` and `:chdir` both run `git clone` from inside the given directory.
+>   When both are given, `:chdir` wins and `:path` is dropped.
+> - `:recursive` carries its value over to `:recurse_submodules` unchanged.
+>   `:recurse_submodules` also accepts a pathspec `String` or `Array<String>`
+>   to initialize only a subset of submodules, which `:recursive` never did.
+> - `:remote` and `:origin` have the same effect (`git clone --origin name`).
+
+| Deprecated call (works in v5.x, removed in v6.0.0) | Replacement |
+|-----------------------------------------------------|-------------|
+| `Git.clone(url, dir, path: p)` | `Git.clone(url, dir, chdir: p)` |
+| `Git.clone(url, dir, recursive: true)` | `Git.clone(url, dir, recurse_submodules: true)` — or a pathspec `String` or `Array<String>` for a subset of submodules |
+| `Git.clone(url, dir, remote: name)` | `Git.clone(url, dir, origin: name)` |
+
+#### `Git::Log` Enumerable interface deprecated
+
+`Git::Log` is a query builder. Calling `each`, `size`, `to_s`, `first`, `last`, or
+`[]` directly on it runs the query and emits a deprecation warning; those methods
+are removed in v6.0.0. Call `Git::Log#execute` instead. It runs the query and
+returns a `Git::Log::Result`, which includes `Enumerable` and provides the same
+six methods. The chainable query methods on `Git::Log` (`since`, `author`,
+`between`, `path`, `max_count`, and so on) are unchanged.
+
+`Git::Log` includes `Enumerable`, so every `Enumerable` method called on the
+builder (`map`, `select`, `count`, `to_a`, `include?`, and so on) goes through the
+deprecated `each` and emits its warning. Move those calls to the result as well,
+not only the six named methods.
+
+> **Snapshot results:** `execute` returns a snapshot. The builder re-runs
+> `git log` only when a query method (`since`, `max_count`, and so on) has been
+> called since the last run, even with the same value as before, so calling
+> `execute` twice on an untouched builder returns equal results without a second
+> `git log`. Keep the result object when a chain of operations needs the same
+> commits rather than calling `g.log` again, which builds a new query.
+
+In the table, `g` is a `Git::Repository`.
+
+| Deprecated call (works in v5.x, removed in v6.0.0) | Replacement |
+|-----------------------------------------------------|-------------|
+| `g.log.each { \|c\| ... }` | `g.log.execute.each { \|c\| ... }` |
+| `g.log.size` | `g.log.execute.size` |
+| `g.log.to_s` | `g.log.execute.to_s` — commits joined with newlines, as before |
+| `g.log.first`, `g.log.last` | `g.log.execute.first`, `g.log.execute.last` |
+| `g.log[i]`, `g.log[range]` | `g.log.execute[i]`, `g.log.execute[range]` |
+| any other `Enumerable` method on the log (`map`, `select`, `count`, `to_a`, `include?`, ...) | the same method on `g.log.execute` |
+
+#### `Git::Object::Commit#set_commit` deprecated
+
+`Git::Object::Commit#set_commit` is deprecated and is removed in v6.0.0. Call
+`from_data` instead; it takes the same parsed commit data hash and has the same
+effect.
+
+| Deprecated call (works in v5.x, removed in v6.0.0) | Replacement |
+|-----------------------------------------------------|-------------|
+| `commit.set_commit(data)` | `commit.from_data(data)` |
+
+#### `Git.export` `:remote` option deprecated
+
+`Git.export` has always dropped a `:remote` option before calling `Git.clone`
+without telling the caller. Passing it now emits a deprecation warning. The option
+is still dropped, so the export itself is unchanged, and it will be removed in a
+future major release. Once it is removed, passing `:remote` raises `ArgumentError`
+like any other unsupported option (see [Unsupported options raise
+`ArgumentError`](#unsupported-options-raise-argumenterror)).
+
+There is no replacement option. `:remote` renamed the clone's remote, and
+`Git.export` deletes the `.git` directory before returning, so the name was never
+observable in the result. Delete the option from the call.
+
+| Deprecated call (works in v5.x, removed in a future major release) | Replacement |
+|--------------------------------------------------------------------|-------------|
+| `Git.export(url, dir, remote: name)` | `Git.export(url, dir)` |
+
 ---

data/lib/git/version.rb

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

data/lib/git.rb

@@ -327,25 +327,36 @@ 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.
   #
-  # Takes the same options as {Git.clone} except that `:remote` is silently ignored
-  # and `:depth` defaults to 1.
+  # Takes the same options as {Git.clone} except that `:depth` defaults to 1 and
+  # `:remote` is ignored with a deprecation warning.
   #
   # @param repository_url [String, URI, Pathname] the repository to export from
   #
   # @param directory [String, Pathname, nil] the directory to export into; defaults to the
   #   repository basename
   #
-  # @param options [Hash] options forwarded to {Git.clone} (`:remote` is ignored;
-  #   `:depth` defaults to 1)
+  # @param options [Hash] options forwarded to {Git.clone} (`:depth` defaults to 1)
   #
-  # @option options [String] :branch the branch or tag to export instead of HEAD
+  # @option options [String] :remote deprecated and ignored; delete it from the call.
+  #   Passing it emits a deprecation warning and it will be removed in a future
+  #   major release.
+  #
+  # @option options [String] :branch the branch or tag to export instead of HEAD.
+  #   Give the short name (`main`, `v1.0.0`); a full ref path such as
+  #   `refs/tags/v1.0.0` or a commit SHA is not accepted. Use `:revision` to
+  #   export a SHA.
   #
   # @return [void]
   #
   def self.export(repository_url, directory = nil, options = {})
-    options.delete(:remote)
+    if options.key?(:remote)
+      Git::Deprecation.warn(
+        'The :remote option to Git.export is ignored, is deprecated, and will be removed in a future ' \
+        'major release. Delete it from the call.'
+      )
+      options.delete(:remote)
+    end
     repo = clone(repository_url, directory, { depth: 1 }.merge(options))
-    repo.checkout("origin/#{options[:branch]}") if options[:branch]
     FileUtils.rm_r File.join(repo.dir.to_s, '.git')
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 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.4.0/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/5.4.0
+  changelog_uri: https://rubydoc.info/gems/git/5.5.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/5.5.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: