From 8b3be992f8f79c2a38408ac9a4d233731f646b2c Mon Sep 17 00:00:00 2001 From: James Couball Date: Sat, 13 Jan 2024 14:24:43 -0800 Subject: [PATCH 1/2] Announce the 2.0.0 pre-release Signed-off-by: James Couball --- README.md | 40 ++++++++++++++++++++++++++++++++-------- git.gemspec | 14 ++++++++------ 2 files changed, 40 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 709d5741..d6195776 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,38 @@ # The Git Gem -The Git Gem provides an API that can be used to create, read, and manipulate -Git repositories by wrapping system calls to the `git` binary. The API can be -used for working with Git in complex interactions including branching and -merging, object inspection and manipulation, history, patch generation and -more. +[![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) + +The [git gem](https://rubygems.org/gems/git) provides an API that can be used to +create, read, and manipulate Git repositories by wrapping system calls to the `git` +command line. The API can be used for working with Git in complex interactions +including branching and merging, object inspection and manipulation, history, patch +generation and more. + +## v2.0.0 pre-release + +git 2.0.0 is available as a pre-release version for testing! Please give it a try. + +The changes coming in this major release include: + +* 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 #617](https://github.com/ruby-git/ruby-git/pull/617) for more details + on the motivation for this implementation. + +The tentative plan is to release `2.0.0` near the end of March 2024 depending on +the feedback received during the pre-release period. + +The `master` branch will be used for `2.x` development. If needed, fixes for `1.x` +version will be done on the `v1` branch. ## Homepage @@ -41,9 +68,6 @@ sudo gem install git ## Code Status -* [![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) -* [![Gem Version](https://badge.fury.io/rb/git.svg)](https://badge.fury.io/rb/git) ## Major Objects diff --git a/git.gemspec b/git.gemspec index 3d6b883f..daff7915 100644 --- a/git.gemspec +++ b/git.gemspec @@ -9,17 +9,19 @@ Gem::Specification.new do |s| s.name = 'git' s.summary = 'An API to create, read, and manipulate Git repositories' s.description = <<~DESCRIPTION - The Git Gem provides an API that can be used to create, read, and manipulate - Git repositories by wrapping system calls to the `git` binary. The API can be - used for working with Git in complex interactions including branching and - merging, object inspection and manipulation, history, patch generation and - more. + The git gem provides an API that can be used to + create, read, and manipulate Git repositories by wrapping system calls to the git + command line. The API can be used for working with Git in complex interactions + including branching and merging, object inspection and manipulation, history, patch + generation and more. DESCRIPTION s.version = Git::VERSION + s.metadata['homepage_uri'] = s.homepage s.metadata['source_code_uri'] = s.homepage - s.metadata['changelog_uri'] = 'http://rubydoc.info/gems/git/file.CHANGELOG.html' + s.metadata['changelog_uri'] = "https://rubydoc.info/gems/#{s.name}/#{s.version}/file/CHANGELOG.md" + s.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{s.name}/#{s.version}" s.require_paths = ['lib'] s.required_ruby_version = '>= 2.3' From aefc363aaa5c5be103c72284017c818e9b413327 Mon Sep 17 00:00:00 2001 From: James Couball Date: Sat, 13 Jan 2024 14:32:30 -0800 Subject: [PATCH 2/2] Instruct JRuby on Windows users to stay with the 1.x release line Signed-off-by: James Couball --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index d6195776..5597228d 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,9 @@ generation and more. git 2.0.0 is available as a pre-release version for testing! Please give it a try. +**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 coming in this major release include: * Create a policy of supported Ruby versions to support only non-EOL Ruby versions