Skip to content

Commit 1afc4c6

Browse files
committed
Update 2.x release line description
1 parent ed52420 commit 1afc4c6

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

README.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
[![Code Climate](https://codeclimate.com/github/ruby-git/ruby-git.png)](https://codeclimate.com/github/ruby-git/ruby-git)
1313

1414
* [Summary](#summary)
15-
* [v2.0.0 pre-release](#v200-pre-release)
15+
* [v2.x Release](#v2x-release)
1616
* [Install](#install)
1717
* [Major Objects](#major-objects)
1818
* [Errors Raised By This Gem](#errors-raised-by-this-gem)
@@ -37,15 +37,20 @@ Get started by obtaining a repository object by:
3737

3838
Methods that can be called on a repository object are documented in [Git::Base](https://rubydoc.info/gems/git/Git/Base)
3939

40-
## v2.0.0 pre-release
40+
## v2.x Release
4141

42-
git 2.0.0 is available as a pre-release version for testing! Please give it a try.
42+
git 2.0.0 has recently been released. Please give it a try.
43+
44+
45+
**If you have problems with the 2.x release, open an issue and use the 1.9.1 version
46+
instead.** We will do our best to fix your issues in a timely fashion.
4347

4448
**JRuby on Windows is not yet supported by the 2.x release line. Users running JRuby
4549
on Windows should continue to use the 1.x release line.**
4650

47-
The changes coming in this major release include:
51+
The changes in this major release include:
4852

53+
* Added a dependency on the activesupport gem to use the deprecation functionality
4954
* Create a policy of supported Ruby versions to support only non-EOL Ruby versions
5055
* Create a policy of supported Git CLI versions (released 2020-12-25)
5156
* Update the required Ruby version to at least 3.0 (released 2020-07-27)
@@ -55,9 +60,6 @@ The changes coming in this major release include:
5560
See [PR #684](https://github.com/ruby-git/ruby-git/pull/684) for more details
5661
on the motivation for this implementation.
5762

58-
The tentative plan is to release `2.0.0` near the end of March 2024 depending on
59-
the feedback received during the pre-release period.
60-
6163
The `master` branch will be used for `2.x` development. If needed, fixes for `1.x`
6264
version will be done on the `v1` branch.
6365

@@ -69,12 +71,24 @@ Install the gem and add to the application's Gemfile by executing:
6971
bundle add git
7072
```
7173

74+
to install version 1.x:
75+
76+
```shell
77+
bundle add git --version "~> 1.19"
78+
```
79+
7280
If bundler is not being used to manage dependencies, install the gem by executing:
7381

7482
```shell
7583
gem install git
7684
```
7785

86+
to install version 1.x:
87+
88+
```shell
89+
gem install git --version "~> 1.19"
90+
```
91+
7892
## Major Objects
7993

8094
**Git::Base** - The object returned from a `Git.open` or `Git.clone`. Most major actions are called from this object.
@@ -505,9 +519,15 @@ end
505519
This gem will be expected to function correctly on:
506520

507521
* All non-EOL versions of the MRI Ruby on Mac, Linux, and Windows
508-
* The latest version of JRuby on Linux and Windows
522+
* The latest version of JRuby on Linux
509523
* The latest version of Truffle Ruby on Linus
510524

525+
It is this project's intent to support the latest version of JRuby on Windows
526+
once the following JRuby bug is fixed:
527+
528+
jruby/jruby#7515
529+
511530
## License
512531

513-
licensed under MIT License Copyright (c) 2008 Scott Chacon. See LICENSE for further details.
532+
Licensed under MIT License Copyright (c) 2008 Scott Chacon. See LICENSE for further
533+
details.

0 commit comments

Comments
 (0)