git 3.0.2 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b470fa5194ac99953b57fa35e69a7f14eadc6c1ad5bcdd6fde4c59278417a15
-  data.tar.gz: f17a9441ed37186bb46f26ee475f3c83f2adde03c6d67e707dd9ba50855d4cbc
+  metadata.gz: 8ea6b964531a2d91cdc46c4e4c7a6d9f79251f246f2c8856c271b989c6d22800
+  data.tar.gz: 3fd581082807719899cdbe85eea5ca8eca35803402f6822c66bd5b95b27de10b
 SHA512:
-  metadata.gz: 6094ef6f1f13e63e00631919cef8bd8c648de4722fa6c4f8f50f95684cd448e46b815c35b1699aff91ce75577c8d40502c0bee21b235b9e32ab0be498e2f34a4
-  data.tar.gz: 1a729e9792ce1b1745f4412b0a164a8b229eccd62952022933725363e2fc23c27baea2076077ef3cfa34672e64725503b964b4e40090f062b1e6b4cb649387b5
+  metadata.gz: ae34ed0370f1ac66b68c03e13ef16d9415e531f3ebe0b7af906dc6d9150c4fc0eec63da7dde987530f7a24bf17966cb3053b40723e0056c78652763340b8e71c
+  data.tar.gz: ec675f610d8d193dac8c0debca9de1480d154b3d09c34e172dbb0e68d7a47625fdcb7d8bef7a5625e3fef8dfd10e029e1ff682ee033b698beebae43414b3454f

data/.github/pull_request_template.md

@@ -1,4 +1,4 @@
-Review our [guidelines for contributing](https://github.com/ruby-git/ruby-git/blob/master/CONTRIBUTING.md) to this repository. A good start is to:
+Review our [guidelines for contributing](https://github.com/ruby-git/ruby-git/blob/main/CONTRIBUTING.md) to this repository. A good start is to:
 
 * Write tests for your changes
 * Run `rake` before pushing

data/.github/workflows/continuous_integration.yml

@@ -1,15 +1,19 @@
 name: CI
 
 on:
-  push:
-    branches: [master,v1]
   pull_request:
-    branches: [master,v1]
+    branches: [main]
   workflow_dispatch:
 
 jobs:
   build:
     name: Ruby ${{ matrix.ruby }} on ${{ matrix.operating-system }}
+
+    # Skip this job if triggered by a release PR
+    if: >-
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'pull_request' && !startsWith(github.event.pull_request.head.ref, 'release-please--'))
+
     runs-on: ${{ matrix.operating-system }}
     continue-on-error: ${{ matrix.experimental == 'Yes' }}
     env: { JAVA_OPTS: -Djdk.io.File.enableADS=true }

data/.github/workflows/enforce_conventional_commits.yml

@@ -7,7 +7,7 @@ permissions:
 on:
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   commit-lint:

data/.github/workflows/experimental_continuous_integration.yml

@@ -2,12 +2,19 @@ name: CI Experimental
 
 on:
   push:
-    branches: [master,v1]
+    branches: [main]
+
   workflow_dispatch:
 
 jobs:
   build:
     name: Ruby ${{ matrix.ruby }} on ${{ matrix.operating-system }}
+
+    # Skip this job if triggered by pushing a release commit
+    if: >-
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'push' && !startsWith(github.event.head_commit.message, 'chore: release '))
+
     runs-on: ${{ matrix.operating-system }}
     continue-on-error: true
     env: { JAVA_OPTS: -Djdk.io.File.enableADS=true }

data/.github/workflows/release.yml

@@ -11,7 +11,7 @@ description: |
 
 on:
   push:
-    branches: ["master"]
+    branches: ["main"]
 
   workflow_dispatch:
 

data/.gitignore

@@ -9,4 +9,5 @@ pkg
 rdoc
 Gemfile.lock
 node_modules
-package-lock.json
+package-lock.json
+ai-prompt.erb

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "3.0.2"
+  ".": "3.1.1"
 }

data/CHANGELOG.md

@@ -5,6 +5,33 @@
 
 # Change Log
 
+## [3.1.1](https://github.com/ruby-git/ruby-git/compare/v3.1.0...v3.1.1) (2025-07-02)
+
+
+### Bug Fixes
+
+* Raise a Git::FailedError if depth < 0 is passed to Git.clone ([803253e](https://github.com/ruby-git/ruby-git/commit/803253ea2dd2b69b099c0d1919b03ac65c800264)), closes [#805](https://github.com/ruby-git/ruby-git/issues/805)
+
+
+### Other Changes
+
+* Announce default branch change in README ([e04f08e](https://github.com/ruby-git/ruby-git/commit/e04f08e202ae54286033b4d0a75c47f124bd63e2))
+* Update the project's default branch from 'master' to 'main' ([a5aa75f](https://github.com/ruby-git/ruby-git/commit/a5aa75fd04a71cd8236b8c8481a067c0a47b24b9))
+
+## [3.1.0](https://github.com/ruby-git/ruby-git/compare/v3.0.2...v3.1.0) (2025-05-18)
+
+
+### Features
+
+* Make Git::Log support the git log --merges option ([df3b07d](https://github.com/ruby-git/ruby-git/commit/df3b07d0f14d79c6c77edc04550c1ad0207c920a))
+
+
+### Other Changes
+
+* Announce and document guidelines for using Conventional Commits ([a832259](https://github.com/ruby-git/ruby-git/commit/a832259314aa9c8bdd7719e50d425917df1df831))
+* Skip continuous integration workflow for release PRs ([f647a18](https://github.com/ruby-git/ruby-git/commit/f647a18c8a3ae78f49c8cd485db4660aa10a92fc))
+* Skip the experiemental build workflow if a release commit is pushed to master ([3dab0b3](https://github.com/ruby-git/ruby-git/commit/3dab0b34e41393a43437c53a53b96895fd3d2cc5))
+
 ## [3.0.2](https://github.com/ruby-git/ruby-git/compare/v3.0.1...v3.0.2) (2025-05-15)
 
 

data/CONTRIBUTING.md

@@ -18,6 +18,8 @@
   - [Output processing](#output-processing)
 - [Coding standards](#coding-standards)
   - [Commit message guidelines](#commit-message-guidelines)
+    - [What does this mean for contributors?](#what-does-this-mean-for-contributors)
+    - [What to know about Conventional Commits](#what-to-know-about-conventional-commits)
   - [Unit tests](#unit-tests)
   - [Continuous integration](#continuous-integration)
   - [Documentation](#documentation)
@@ -63,7 +65,8 @@ thoroughly as possible to describe the issue or feature request.
 There is a three-step process for submitting code or documentation changes:
 
 1. [Commit your changes to a fork of
-   `ruby-git`](#commit-your-changes-to-a-fork-of-ruby-git)
+   `ruby-git`](#commit-your-changes-to-a-fork-of-ruby-git) using [Conventional
+   Commits](#commit-message-guidelines)
 2. [Create a pull request](#create-a-pull-request)
 3. [Get your pull request reviewed](#get-your-pull-request-reviewed)
 
@@ -155,23 +158,81 @@ requirements:
 
 ### Commit message guidelines
 
-All commit messages must follow the [Conventional Commits
-standard](https://www.conventionalcommits.org/en/v1.0.0/). This helps us maintain a
-clear and structured commit history, automate versioning, and generate changelogs
-effectively.
+To enhance our development workflow, enable automated changelog generation, and pave
+the way for Continuous Delivery, the `ruby-git` project has adopted the [Conventional
+Commits standard](https://www.conventionalcommits.org/en/v1.0.0/) for all commit
+messages.
 
-To ensure compliance, this project includes:
+This structured approach to commit messages allows us to:
 
-- A git commit-msg hook that validates your commit messages before they are accepted.
+- **Automate versioning and releases:** Tools can now automatically determine the
+  semantic version bump (patch, minor, major) based on the types of commits merged.
+- **Generate accurate changelogs:** We can automatically create and update a
+  `CHANGELOG.md` file, providing a clear history of changes for users and
+  contributors.
+- **Improve commit history readability:** A standardized format makes it easier for
+  everyone to understand the nature of changes at a glance.
 
-  To activate the hook, you must have node installed and run `bin/setup` or
-  `npm install`.
+#### What does this mean for contributors?
 
-- A GitHub Actions workflow that will enforce the Conventional Commit standard as
-  part of the continuous integration pipeline.
+Going forward, all commits to this repository **MUST** adhere to the [Conventional
+Commits standard](https://www.conventionalcommits.org/en/v1.0.0/). Commits not
+adhering to this standard will cause the CI build to fail. PRs will not be merged if
+they include non-conventional commits.
 
-  Any commit message that does not conform to the Conventional Commits standard will
-  cause the workflow to fail and not allow the PR to be merged.
+A git pre-commit hook may be installed to validate your conventional commit messages
+before pushing them to GitHub by running `bin/setup` in the project root.
+
+#### What to know about Conventional Commits
+
+The simplist conventional commit is in the form `type: description` where `type`
+indicates the type of change and `description` is your usual commit message (with
+some limitations).
+
+- Types include: `feat`, `fix`, `docs`, `test`, `refactor`, and `chore`. See the full
+  list of types supported in [.commitlintrc.yml](.commitlintrc.yml).
+- The description must (1) not start with an upper case letter, (2) be no more than
+  100 characters, and (3) not end with punctuation.
+
+Examples of valid commits:
+
+- `feat: add the --merges option to Git::Lib.log`
+- `fix: exception thrown by Git::Lib.log when repo has no commits`
+- `docs: add conventional commit announcement to README.md`
+
+Commits that include breaking changes must include an exclaimation mark before the
+colon:
+
+- `feat!: removed Git::Base.commit_force`
+
+The commit messages will drive how the version is incremented for each release:
+
+- a release containing a **breaking change** will do a **major** version increment
+- a release containing a **new feature** will do a **minor** increment
+- a release containing **neither a breaking change nor a new feature** will do a
+  **patch** version increment
+
+The full conventional commit format is:
+
+```text
+<type>[optional scope][!]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+- `optional body` may include multiple lines of descriptive text limited to 100 chars
+  each
+- `optional footers` only uses `BREAKING CHANGE: <description>` where description
+  should describe the nature of the backward incompatibility.
+
+Use of the `BREAKING CHANGE:` footer flags a backward incompatible change even if it
+is not flagged with an exclaimation mark after the `type`. Other footers are allowed
+by not acted upon.
+
+See [the Conventional Commits
+specification](https://www.conventionalcommits.org/en/v1.0.0/) for more details.
 
 ### Unit tests
 

data/README.md

@@ -8,18 +8,44 @@
 [![Gem Version](https://badge.fury.io/rb/git.svg)](https://badge.fury.io/rb/git)
 [![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/git/)
 [![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/git/file/CHANGELOG.md)
-[![Build Status](https://github.com/ruby-git/ruby-git/workflows/CI/badge.svg?branch=master)](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI)
-[![Code Climate](https://codeclimate.com/github/ruby-git/ruby-git.png)](https://codeclimate.com/github/ruby-git/ruby-git)
-
-* [Summary](#summary)
-* [v2.x Release](#v2x-release)
-* [Install](#install)
-* [Major Objects](#major-objects)
-* [Errors Raised By This Gem](#errors-raised-by-this-gem)
-* [Specifying And Handling Timeouts](#specifying-and-handling-timeouts)
-* [Examples](#examples)
-* [Ruby version support policy](#ruby-version-support-policy)
-* [License](#license)
+[![Build Status](https://github.com/ruby-git/ruby-git/workflows/CI/badge.svg?branch=main)](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+
+- [📢 Default Branch Rename 📢](#-default-branch-rename-)
+- [📢 We've Switched to Conventional Commits 📢](#-weve-switched-to-conventional-commits-)
+- [Summary](#summary)
+- [Install](#install)
+- [Major Objects](#major-objects)
+- [Errors Raised By This Gem](#errors-raised-by-this-gem)
+- [Specifying And Handling Timeouts](#specifying-and-handling-timeouts)
+- [Examples](#examples)
+- [Ruby version support policy](#ruby-version-support-policy)
+- [License](#license)
+
+## 📢 Default Branch Rename 📢
+
+On June 6th, 2025, the default branch was renamed from 'master' to 'main'.
+
+Instructions for renaming your local or forked branch to match can be found in the
+gist [Default Branch Name
+Change](https://gist.github.com/jcouball/580a10e395f7fdfaaa4297bbe816cc7d).
+
+## 📢 We've Switched to Conventional Commits 📢
+
+To enhance our development workflow, enable automated changelog generation, and pave
+the way for Continuous Delivery, the `ruby-git` project has adopted the [Conventional
+Commits standard](https://www.conventionalcommits.org/en/v1.0.0/) for all commit
+messages.
+
+Going forward, all commits to this repository **MUST** adhere to the Conventional
+Commits standard. Commits not adhering to this standard will cause the CI build to
+fail. PRs will not be merged if they include non-conventional commits.
+
+A git pre-commit hook may be installed to validate your conventional commit messages
+before pushing them to GitHub by running `bin/setup` in the project root.
+
+Read more about this change in the [Commit Message Guidelines section of
+CONTRIBUTING.md](CONTRIBUTING.md#commit-message-guidelines)
 
 ## Summary
 
@@ -34,31 +60,6 @@ Get started by obtaining a repository object by:
 
 Methods that can be called on a repository object are documented in [Git::Base](https://rubydoc.info/gems/git/Git/Base)
 
-## v2.x Release
-
-git 2.0.0 has recently been released. Please give it a try.
-
-**If you have problems with the 2.x release, open an issue and use the 1.x version
-instead.** We will do our best to fix your issues in a timely fashion.
-
-**JRuby on Windows is not yet supported by the 2.x release line. Users running JRuby
-on Windows should continue to use the 1.x release line.**
-
-The changes in this major release include:
-
-* Added a dependency on the activesupport gem to use the deprecation functionality
-* Create a policy of supported Ruby versions to support only non-EOL Ruby versions
-* Create a policy of supported Git CLI versions (released 2020-12-25)
-* Update the required Ruby version to at least 3.0 (released 2020-07-27)
-* Update the required Git command line version to at least 2.28
-* Update how CLI commands are called to use the [process_executer](https://github.com/main-branch/process_executer)
-  gem which is built on top of [Kernel.spawn](https://ruby-doc.org/3.3.0/Kernel.html#method-i-spawn).
-  See [PR #684](https://github.com/ruby-git/ruby-git/pull/684) for more details
-  on the motivation for this implementation.
-
-The `master` branch will be used for `2.x` development. If needed, fixes for `1.x`
-version will be done on the `v1` branch.
-
 ## Install
 
 Install the gem and add to the application's Gemfile by executing:
@@ -283,8 +284,8 @@ g.branches # returns Git::Branch objects
 g.branches.local
 g.current_branch
 g.branches.remote
-g.branches[:master].gcommit
-g.branches['origin/master'].gcommit
+g.branches[:main].gcommit
+g.branches['origin/main'].gcommit
 
 g.grep('hello')  # implies HEAD
 g.blob('v2.5:Makefile').grep('hello')
@@ -341,7 +342,7 @@ Git.ls_remote('https://github.com/ruby-git/ruby-git.git') # returns a hash conta
 Git.ls_remote('/path/to/local/repo')
 Git.ls_remote() # same as Git.ls_remote('.')
 
-Git.default_branch('https://github.com/ruby-git/ruby-git') #=> 'master'
+Git.default_branch('https://github.com/ruby-git/ruby-git') #=> 'main'
 ```
 
 And here are the operations that will need to write to your git repository.
@@ -414,13 +415,13 @@ g.branch('new_branch') # creates new or fetches existing
 g.branch('new_branch').checkout
 g.branch('new_branch').delete
 g.branch('existing_branch').checkout
-g.branch('master').contains?('existing_branch')
+g.branch('main').contains?('existing_branch')
 
 # delete remote branch
 g.push('origin', 'remote_branch_name', force: true, delete: true)
 
 g.checkout('new_branch')
-g.checkout('new_branch', new_branch: true, start_point: 'master')
+g.checkout('new_branch', new_branch: true, start_point: 'main')
 g.checkout(g.branch('new_branch'))
 
 g.branch(name).merge(branch2)
@@ -430,7 +431,7 @@ g.branch(name).in_branch(message) { # add files }  # auto-commits
 g.merge('new_branch')
 g.merge('new_branch', 'merge commit message', no_ff: true)
 g.merge('origin/remote_branch')
-g.merge(g.branch('master'))
+g.merge(g.branch('main'))
 g.merge([branch1, branch2])
 
 g.merge_base('branch1', 'branch2')

data/lib/git/lib.rb

@@ -126,7 +126,7 @@ module Git
       arr_opts = []
       arr_opts << '--bare' if opts[:bare]
       arr_opts << '--branch' << opts[:branch] if opts[:branch]
-      arr_opts << '--depth' << opts[:depth].to_i if opts[:depth] && opts[:depth].to_i > 0
+      arr_opts << '--depth' << opts[:depth].to_i if opts[:depth]
       arr_opts << '--filter' << opts[:filter] if opts[:filter]
       Array(opts[:config]).each { |c| arr_opts << '--config' << c }
       arr_opts << '--origin' << opts[:remote] || opts[:origin] if opts[:remote] || opts[:origin]
@@ -294,6 +294,7 @@ module Git
     #   * 'tree' [String] the tree sha
     #   * 'author' [String] the author of the commit and timestamp of when the changes were created
     #   * 'committer' [String] the committer of the commit and timestamp of when the commit was applied
+    #   * 'merges' [Boolean] if truthy, only include merge commits (aka commits with 2 or more parents)
     #
     # @raise [ArgumentError] if the revision range (specified with :between or :object) is a string starting with a hyphen
     #
@@ -305,6 +306,7 @@ module Git
 
       arr_opts << '--pretty=raw'
       arr_opts << "--skip=#{opts[:skip]}" if opts[:skip]
+      arr_opts << '--merges' if opts[:merges]
 
       arr_opts += log_path_options(opts)
 

data/lib/git/log.rb

@@ -133,11 +133,16 @@ module Git
       return self
     end
 
+    def merges
+      dirty_log
+      @merges = true
+      return self
+    end
+
     def to_s
       self.map { |c| c.to_s }.join("\n")
     end
 
-
     # forces git log to run
 
     def size
@@ -184,7 +189,7 @@ module Git
         log = @base.lib.full_log_commits(
           count: @max_count, all: @all, object: @object, path_limiter: @path, since: @since,
           author: @author, grep: @grep, skip: @skip, until: @until, between: @between,
-          cherry: @cherry
+          cherry: @cherry, merges: @merges
         )
         @commits = log.map { |c| Git::Object::Commit.new(@base, c['sha'], c) }
       end

data/lib/git/version.rb

@@ -3,5 +3,5 @@
 module Git
   # The current gem version
   # @return [String] the current gem version.
-  VERSION='3.0.2'
+  VERSION='3.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.1
 platform: ruby
 authors:
 - Scott Chacon and others
@@ -248,8 +248,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/3.0.2/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/3.0.2
+  changelog_uri: https://rubydoc.info/gems/git/3.1.1/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/3.1.1
 rdoc_options: []
 require_paths:
 - lib