12
12
[ ![ Code Climate] ( https://codeclimate.com/github/ruby-git/ruby-git.png )] ( https://codeclimate.com/github/ruby-git/ruby-git )
13
13
14
14
* [ Summary] ( #summary )
15
- * [ v2.0.0 pre-release ] ( #v200-pre -release )
15
+ * [ v2.x Release ] ( #v2x -release )
16
16
* [ Install] ( #install )
17
17
* [ Major Objects] ( #major-objects )
18
18
* [ Errors Raised By This Gem] ( #errors-raised-by-this-gem )
@@ -37,15 +37,20 @@ Get started by obtaining a repository object by:
37
37
38
38
Methods that can be called on a repository object are documented in [ Git::Base] ( https://rubydoc.info/gems/git/Git/Base )
39
39
40
- ## v2.0.0 pre-release
40
+ ## v2.x Release
41
41
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.
43
47
44
48
** JRuby on Windows is not yet supported by the 2.x release line. Users running JRuby
45
49
on Windows should continue to use the 1.x release line.**
46
50
47
- The changes coming in this major release include:
51
+ The changes in this major release include:
48
52
53
+ * Added a dependency on the activesupport gem to use the deprecation functionality
49
54
* Create a policy of supported Ruby versions to support only non-EOL Ruby versions
50
55
* Create a policy of supported Git CLI versions (released 2020-12-25)
51
56
* 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:
55
60
See [ PR #684 ] ( https://github.com/ruby-git/ruby-git/pull/684 ) for more details
56
61
on the motivation for this implementation.
57
62
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
-
61
63
The ` master ` branch will be used for ` 2.x ` development. If needed, fixes for ` 1.x `
62
64
version will be done on the ` v1 ` branch.
63
65
@@ -69,12 +71,24 @@ Install the gem and add to the application's Gemfile by executing:
69
71
bundle add git
70
72
```
71
73
74
+ to install version 1.x:
75
+
76
+ ``` shell
77
+ bundle add git --version " ~> 1.19"
78
+ ```
79
+
72
80
If bundler is not being used to manage dependencies, install the gem by executing:
73
81
74
82
``` shell
75
83
gem install git
76
84
```
77
85
86
+ to install version 1.x:
87
+
88
+ ``` shell
89
+ gem install git --version " ~> 1.19"
90
+ ```
91
+
78
92
## Major Objects
79
93
80
94
** Git::Base** - The object returned from a ` Git.open ` or ` Git.clone ` . Most major actions are called from this object.
505
519
This gem will be expected to function correctly on:
506
520
507
521
* 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
509
523
* The latest version of Truffle Ruby on Linus
510
524
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
+
511
530
## License
512
531
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