22Changelog
33=========
44
5- 3.1.20
5+ 3.1.21
66======
77
8- * This is the second typed release with a lot of improvements under the hood.
8+ * This is the second typed release with a lot of improvements under the hood.
9+
10+ * General:
11+ - Remove python 3.6 support
12+ - Remove distutils inline with deprecation in standard library.
13+ - Update sphinx to 4.1.12 and use autodoc-typehints.
14+
15+ * Typing:
16+ - Add types to ALL functions.
17+ - Ensure py.typed is collected.
18+ - Increase mypy strictness with disallow_untyped_defs, warn_redundant_casts, warn_unreachable.
19+ - Use typing.NamedTuple and typing.OrderedDict now 3.6 dropped.
20+ - Remove use of typing.TypeGuard until later release, to allow dependant libs time to update.
21+ - Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095
22+
23+ * Runtime improvements:
24+ - Add clone_multi_options support to submodule.add()
25+ - Delay calling get_user_id() unless essential, to support sand-boxed environments.
26+ - Add timeout to handle_process_output(), in case thread.join() hangs.
27+
28+ See the following for details:
29+ https://github.com/gitpython-developers/gitpython/milestone/52?closed=1
30+
31+
32+ 3.1.20 (YANKED)
33+ ======
34+
35+ * This is the second typed release with a lot of improvements under the hood.
936 * Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095
10-
37+
1138See the following for details:
12- https://github.com/gitpython-developers/gitpython/milestone/52?closed=1
39+ https://github.com/gitpython-developers/gitpython/milestone/52?closed=1
1340
1441
15423.1.19 (YANKED)
1643===============
1744
18- * This is the second typed release with a lot of improvements under the hood.
45+ * This is the second typed release with a lot of improvements under the hood.
1946 * Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095
20-
47+
2148See the following for details:
22- https://github.com/gitpython-developers/gitpython/milestone/51?closed=1
49+ https://github.com/gitpython-developers/gitpython/milestone/51?closed=1
2350
24513.1.18
2552======
2653
2754* drop support for python 3.5 to reduce maintenance burden on typing. Lower patch levels of python 3.5 would break, too.
2855
2956See the following for details:
30- https://github.com/gitpython-developers/gitpython/milestone/50?closed=1
57+ https://github.com/gitpython-developers/gitpython/milestone/50?closed=1
3158
32593.1.17
3360======
@@ -37,7 +64,7 @@ https://github.com/gitpython-developers/gitpython/milestone/50?closed=1
3764* Add more static typing information
3865
3966See the following for details:
40- https://github.com/gitpython-developers/gitpython/milestone/49?closed=1
67+ https://github.com/gitpython-developers/gitpython/milestone/49?closed=1
4168
42693.1.16 (YANKED)
4370===============
@@ -46,15 +73,15 @@ https://github.com/gitpython-developers/gitpython/milestone/49?closed=1
4673* Add more static typing information
4774
4875See the following for details:
49- https://github.com/gitpython-developers/gitpython/milestone/48?closed=1
76+ https://github.com/gitpython-developers/gitpython/milestone/48?closed=1
5077
51783.1.15 (YANKED)
5279===============
5380
5481* add deprectation warning for python 3.5
5582
5683See the following for details:
57- https://github.com/gitpython-developers/gitpython/milestone/47?closed=1
84+ https://github.com/gitpython-developers/gitpython/milestone/47?closed=1
5885
59863.1.14
6087======
@@ -65,40 +92,40 @@ https://github.com/gitpython-developers/gitpython/milestone/47?closed=1
6592* Drop python 3.4 support
6693
6794See the following for details:
68- https://github.com/gitpython-developers/gitpython/milestone/46?closed=1
95+ https://github.com/gitpython-developers/gitpython/milestone/46?closed=1
6996
70973.1.13
7198======
7299
73100See the following for details:
74- https://github.com/gitpython-developers/gitpython/milestone/45?closed=1
101+ https://github.com/gitpython-developers/gitpython/milestone/45?closed=1
75102
761033.1.12
77104======
78105
79106See the following for details:
80- https://github.com/gitpython-developers/gitpython/milestone/44?closed=1
107+ https://github.com/gitpython-developers/gitpython/milestone/44?closed=1
81108
821093.1.11
83110======
84111
85112Fixes regression of 3.1.10.
86113
87114See the following for details:
88- https://github.com/gitpython-developers/gitpython/milestone/43?closed=1
115+ https://github.com/gitpython-developers/gitpython/milestone/43?closed=1
89116
901173.1.10
91118======
92119
93120See the following for details:
94- https://github.com/gitpython-developers/gitpython/milestone/42?closed=1
121+ https://github.com/gitpython-developers/gitpython/milestone/42?closed=1
95122
96123
971243.1.9
98125=====
99126
100127See the following for details:
101- https://github.com/gitpython-developers/gitpython/milestone/41?closed=1
128+ https://github.com/gitpython-developers/gitpython/milestone/41?closed=1
102129
103130
1041313.1.8
@@ -109,7 +136,7 @@ https://github.com/gitpython-developers/gitpython/milestone/41?closed=1
109136
110137
111138See the following for more details:
112- https://github.com/gitpython-developers/gitpython/milestone/40?closed=1
139+ https://github.com/gitpython-developers/gitpython/milestone/40?closed=1
113140
114141
1151423.1.7
@@ -135,13 +162,13 @@ https://github.com/gitpython-developers/gitpython/milestone/40?closed=1
135162* package size was reduced significantly not placing tests into the package anymore.
136163
137164See the following for details:
138- https://github.com/gitpython-developers/gitpython/milestone/39?closed=1
165+ https://github.com/gitpython-developers/gitpython/milestone/39?closed=1
139166
1401673.1.3
141168=====
142169
143170See the following for details:
144- https://github.com/gitpython-developers/gitpython/milestone/38?closed=1
171+ https://github.com/gitpython-developers/gitpython/milestone/38?closed=1
145172
1461733.1.2
147174=====
@@ -190,7 +217,7 @@ Bugfixes
190217Bugfixes
191218--------
192219
193- * Fixed Repo.__repr__ when subclassed
220+ * Fixed Repo.__repr__ when subclassed
194221 (`#968 <https://github.com/gitpython-developers/GitPython/pull/968 >`_)
195222* Removed compatibility shims for Python < 3.4 and old mock library
196223* Replaced usage of deprecated unittest aliases and Logger.warn
@@ -213,7 +240,7 @@ Bugfixes
213240--------
214241
215242* Fixed warning for usage of environment variables for paths containing ``$ `` or ``% ``
216- (`#832 <https://github.com/gitpython-developers/GitPython/issues/832 >`_,
243+ (`#832 <https://github.com/gitpython-developers/GitPython/issues/832 >`_,
217244 `#961 <https://github.com/gitpython-developers/GitPython/pull/961 >`_)
218245* Added support for parsing Git internal date format (@<unix timestamp> <timezone offset>)
219246 (`#965 <https://github.com/gitpython-developers/GitPython/pull/965 >`_)
@@ -371,7 +398,7 @@ Notable fixes
371398* The `GIT_DIR ` environment variable does not override the `path ` argument when
372399 initializing a `Repo ` object anymore. However, if said `path ` unset, `GIT_DIR `
373400 will be used to fill the void.
374-
401+
375402All issues and PRs can be viewed in all detail when following this URL:
376403https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone%3A%22v2.1.0+-+proper+windows+support%22
377404
@@ -401,7 +428,7 @@ https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone
4014282.0.7 - New Features
402429====================
403430
404- * `IndexFile.commit(...,skip_hooks=False) ` added. This parameter emulates the
431+ * `IndexFile.commit(...,skip_hooks=False) ` added. This parameter emulates the
405432 behaviour of `--no-verify ` on the command-line.
406433
4074342.0.6 - Fixes and Features
@@ -441,7 +468,7 @@ https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone
441468 commit messages contained ``\r `` characters
442469* Fix: progress handler exceptions are not caught anymore, which would usually just hide bugs
443470 previously.
444- * Fix: The `Git.execute ` method will now redirect `stdout ` to `devnull ` if `with_stdout ` is false,
471+ * Fix: The `Git.execute ` method will now redirect `stdout ` to `devnull ` if `with_stdout ` is false,
445472 which is the intended behaviour based on the parameter's documentation.
446473
4474742.0.2 - Fixes