|
2 | 2 | Changelog |
3 | 3 | ========= |
4 | 4 |
|
5 | | -3.1.20 |
| 5 | +3.1.21 |
6 | 6 | ====== |
7 | 7 |
|
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. |
9 | 36 | * Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095 |
10 | | - |
| 37 | + |
11 | 38 | See 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 |
13 | 40 |
|
14 | 41 |
|
15 | 42 | 3.1.19 (YANKED) |
16 | 43 | =============== |
17 | 44 |
|
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. |
19 | 46 | * Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095 |
20 | | - |
| 47 | + |
21 | 48 | See 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 |
23 | 50 |
|
24 | 51 | 3.1.18 |
25 | 52 | ====== |
26 | 53 |
|
27 | 54 | * drop support for python 3.5 to reduce maintenance burden on typing. Lower patch levels of python 3.5 would break, too. |
28 | 55 |
|
29 | 56 | See 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 |
31 | 58 |
|
32 | 59 | 3.1.17 |
33 | 60 | ====== |
@@ -37,7 +64,7 @@ https://github.com/gitpython-developers/gitpython/milestone/50?closed=1 |
37 | 64 | * Add more static typing information |
38 | 65 |
|
39 | 66 | See 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 |
41 | 68 |
|
42 | 69 | 3.1.16 (YANKED) |
43 | 70 | =============== |
@@ -46,15 +73,15 @@ https://github.com/gitpython-developers/gitpython/milestone/49?closed=1 |
46 | 73 | * Add more static typing information |
47 | 74 |
|
48 | 75 | See 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 |
50 | 77 |
|
51 | 78 | 3.1.15 (YANKED) |
52 | 79 | =============== |
53 | 80 |
|
54 | 81 | * add deprectation warning for python 3.5 |
55 | 82 |
|
56 | 83 | See 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 |
58 | 85 |
|
59 | 86 | 3.1.14 |
60 | 87 | ====== |
@@ -65,40 +92,40 @@ https://github.com/gitpython-developers/gitpython/milestone/47?closed=1 |
65 | 92 | * Drop python 3.4 support |
66 | 93 |
|
67 | 94 | See 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 |
69 | 96 |
|
70 | 97 | 3.1.13 |
71 | 98 | ====== |
72 | 99 |
|
73 | 100 | See 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 |
75 | 102 |
|
76 | 103 | 3.1.12 |
77 | 104 | ====== |
78 | 105 |
|
79 | 106 | See 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 |
81 | 108 |
|
82 | 109 | 3.1.11 |
83 | 110 | ====== |
84 | 111 |
|
85 | 112 | Fixes regression of 3.1.10. |
86 | 113 |
|
87 | 114 | See 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 |
89 | 116 |
|
90 | 117 | 3.1.10 |
91 | 118 | ====== |
92 | 119 |
|
93 | 120 | See 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 |
95 | 122 |
|
96 | 123 |
|
97 | 124 | 3.1.9 |
98 | 125 | ===== |
99 | 126 |
|
100 | 127 | See 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 |
102 | 129 |
|
103 | 130 |
|
104 | 131 | 3.1.8 |
@@ -109,7 +136,7 @@ https://github.com/gitpython-developers/gitpython/milestone/41?closed=1 |
109 | 136 |
|
110 | 137 |
|
111 | 138 | See 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 |
113 | 140 |
|
114 | 141 |
|
115 | 142 | 3.1.7 |
@@ -135,13 +162,13 @@ https://github.com/gitpython-developers/gitpython/milestone/40?closed=1 |
135 | 162 | * package size was reduced significantly not placing tests into the package anymore. |
136 | 163 |
|
137 | 164 | See 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 |
139 | 166 |
|
140 | 167 | 3.1.3 |
141 | 168 | ===== |
142 | 169 |
|
143 | 170 | See 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 |
145 | 172 |
|
146 | 173 | 3.1.2 |
147 | 174 | ===== |
@@ -190,7 +217,7 @@ Bugfixes |
190 | 217 | Bugfixes |
191 | 218 | -------- |
192 | 219 |
|
193 | | -* Fixed Repo.__repr__ when subclassed |
| 220 | +* Fixed Repo.__repr__ when subclassed |
194 | 221 | (`#968 <https://github.com/gitpython-developers/GitPython/pull/968>`_) |
195 | 222 | * Removed compatibility shims for Python < 3.4 and old mock library |
196 | 223 | * Replaced usage of deprecated unittest aliases and Logger.warn |
@@ -213,7 +240,7 @@ Bugfixes |
213 | 240 | -------- |
214 | 241 |
|
215 | 242 | * 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>`_, |
217 | 244 | `#961 <https://github.com/gitpython-developers/GitPython/pull/961>`_) |
218 | 245 | * Added support for parsing Git internal date format (@<unix timestamp> <timezone offset>) |
219 | 246 | (`#965 <https://github.com/gitpython-developers/GitPython/pull/965>`_) |
@@ -371,7 +398,7 @@ Notable fixes |
371 | 398 | * The `GIT_DIR` environment variable does not override the `path` argument when |
372 | 399 | initializing a `Repo` object anymore. However, if said `path` unset, `GIT_DIR` |
373 | 400 | will be used to fill the void. |
374 | | - |
| 401 | + |
375 | 402 | All issues and PRs can be viewed in all detail when following this URL: |
376 | 403 | https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone%3A%22v2.1.0+-+proper+windows+support%22 |
377 | 404 |
|
@@ -401,7 +428,7 @@ https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone |
401 | 428 | 2.0.7 - New Features |
402 | 429 | ==================== |
403 | 430 |
|
404 | | -* `IndexFile.commit(...,skip_hooks=False)` added. This parameter emulates the |
| 431 | +* `IndexFile.commit(...,skip_hooks=False)` added. This parameter emulates the |
405 | 432 | behaviour of `--no-verify` on the command-line. |
406 | 433 |
|
407 | 434 | 2.0.6 - Fixes and Features |
@@ -441,7 +468,7 @@ https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone |
441 | 468 | commit messages contained ``\r`` characters |
442 | 469 | * Fix: progress handler exceptions are not caught anymore, which would usually just hide bugs |
443 | 470 | 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, |
445 | 472 | which is the intended behaviour based on the parameter's documentation. |
446 | 473 |
|
447 | 474 | 2.0.2 - Fixes |
|