-
-
Notifications
You must be signed in to change notification settings - Fork 911
/
changes.rst
1174 lines (829 loc) · 42.6 KB
/
changes.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
=========
Changelog
=========
3.1.37
======
This release contains another security fix that further improves validation of symbolic references
and thus properly fixes this CVE: https://github.com/advisories/GHSA-cwvm-v4w8-q58c .
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/67?closed=1
3.1.36
======
Note that this release should be a no-op, it's mainly for testing the changed release-process.
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/66?closed=1
3.1.35
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/65?closed=1
3.1.34
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/64?closed=1
3.1.33
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/63?closed=1
3.1.32
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/62?closed=1
3.1.31
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/61?closed=1
3.1.30
======
- Make injections of command-invocations harder or impossible for clone and others.
See https://github.com/gitpython-developers/GitPython/pull/1518 for details.
Note that this might constitute a breaking change for some users, and if so please
let us know and we add an opt-out to this.
- Prohibit insecure options and protocols by default, which is potentially a breaking change,
but a necessary fix for https://github.com/gitpython-developers/GitPython/issues/1515.
Please take a look at the PR for more information and how to bypass these protections
in case they cause breakage: https://github.com/gitpython-developers/GitPython/pull/1521.
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/60?closed=1
3.1.29
======
- Make the git.__version__ re-appear.
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/59?closed=1
3.1.28
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/58?closed=1
3.1.27
======
- Reduced startup time due to optimized imports.
- Fix a vulenerability that could cause great slowdowns when encountering long remote path names
when pulling/fetching.
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/57?closed=1
3.1.26
======
- Fixes a leaked file descriptor when reading the index, which would cause make writing a previously
read index on windows impossible.
See https://github.com/gitpython-developers/GitPython/issues/1395 for details.
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/56?closed=1
3.1.25
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/55?closed=1
3.1.24
======
* Newly added timeout flag is not be enabled by default, and was renamed to kill_after_timeout
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/54?closed=1
https://github.com/gitpython-developers/gitpython/milestone/53?closed=1
3.1.23 (YANKED)
===============
* This is the second typed release with a lot of improvements under the hood.
* General:
- Remove python 3.6 support
- Remove distutils ahead of deprecation in standard library.
- Update sphinx to 4.1.12 and use autodoc-typehints.
- Include README as long_description on PyPI
- Test against earliest and latest minor version available on Github Actions (e.g. 3.9.0 and 3.9.7)
* Typing:
- Add types to ALL functions.
- Ensure py.typed is collected.
- Increase mypy strictness with disallow_untyped_defs, warn_redundant_casts, warn_unreachable.
- Use typing.NamedTuple and typing.OrderedDict now 3.6 dropped.
- Make Protocol classes ABCs at runtime due to new behaviour/bug in 3.9.7 & 3.10.0-rc1
- Remove use of typing.TypeGuard until later release, to allow dependent libs time to update.
- Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095
* Runtime improvements:
- Add clone_multi_options support to submodule.add()
- Delay calling get_user_id() unless essential, to support sand-boxed environments.
- Add timeout to handle_process_output(), in case thread.join() hangs.
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/53?closed=1
3.1.20 (YANKED)
===============
* This is the second typed release with a lot of improvements under the hood.
* Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/52?closed=1
3.1.19 (YANKED)
===============
* This is the second typed release with a lot of improvements under the hood.
* Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/51?closed=1
3.1.18
======
* drop support for python 3.5 to reduce maintenance burden on typing. Lower patch levels of python 3.5 would break, too.
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/50?closed=1
3.1.17
======
* Fix issues from 3.1.16 (see https://github.com/gitpython-developers/GitPython/issues/1238)
* Fix issues from 3.1.15 (see https://github.com/gitpython-developers/GitPython/issues/1223)
* Add more static typing information
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/49?closed=1
3.1.16 (YANKED)
===============
* Fix issues from 3.1.15 (see https://github.com/gitpython-developers/GitPython/issues/1223)
* Add more static typing information
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/48?closed=1
3.1.15 (YANKED)
===============
* add deprecation warning for python 3.5
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/47?closed=1
3.1.14
======
* git.Commit objects now have a ``replace`` method that will return a
copy of the commit with modified attributes.
* Add python 3.9 support
* Drop python 3.4 support
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/46?closed=1
3.1.13
======
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/45?closed=1
3.1.12
======
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/44?closed=1
3.1.11
======
Fixes regression of 3.1.10.
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/43?closed=1
3.1.10
======
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/42?closed=1
3.1.9
=====
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/41?closed=1
3.1.8
=====
* support for 'includeIf' in git configuration files
* tests are now excluded from the package, making it conisderably smaller
See the following for more details:
https://github.com/gitpython-developers/gitpython/milestone/40?closed=1
3.1.7
=====
* Fix tutorial examples, which disappeared in 3.1.6 due to a missed path change.
3.1.6
=====
* Greatly reduced package size, see https://github.com/gitpython-developers/GitPython/pull/1031
3.1.5
=====
* rollback: package size was reduced significantly not placing tests into the package anymore.
See https://github.com/gitpython-developers/GitPython/issues/1030
3.1.4
=====
* all exceptions now keep track of their cause
* package size was reduced significantly not placing tests into the package anymore.
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/39?closed=1
3.1.3
=====
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/38?closed=1
3.1.2
=====
* Re-release of 3.1.1, with known signature
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/37?closed=1
3.1.1
=====
* support for PyOxidizer, which previously failed due to usage of `__file__`.
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/36?closed=1
3.1.0
=====
* Switched back to using gitdb package as requirement
(`gitdb#59 <https://github.com/gitpython-developers/gitdb/issues/59>`_)
3.0.9
=====
* Restricted GitDB (gitdb2) version requirement to < 4
* Removed old nose library from test requirements
Bugfixes
--------
* Changed to use UTF-8 instead of default encoding when getting information about a symbolic reference
(`#774 <https://github.com/gitpython-developers/GitPython/issues/774>`_)
* Fixed decoding of tag object message so as to replace invalid bytes
(`#943 <https://github.com/gitpython-developers/GitPython/issues/943>`_)
3.0.8
=====
* Added support for Python 3.8
* Bumped GitDB (gitdb2) version requirement to > 3
Bugfixes
--------
* Fixed Repo.__repr__ when subclassed
(`#968 <https://github.com/gitpython-developers/GitPython/pull/968>`_)
* Removed compatibility shims for Python < 3.4 and old mock library
* Replaced usage of deprecated unittest aliases and Logger.warn
* Removed old, no longer used assert methods
* Replaced usage of nose assert methods with unittest
3.0.7
=====
Properly signed re-release of v3.0.6 with new signature
(See `#980 <https://github.com/gitpython-developers/GitPython/issues/980>`_)
3.0.6
=====
| Note: There was an issue that caused this version to be released to PyPI without a signature
| See the changelog for v3.0.7 and `#980 <https://github.com/gitpython-developers/GitPython/issues/980>`_
Bugfixes
--------
* Fixed warning for usage of environment variables for paths containing ``$`` or ``%``
(`#832 <https://github.com/gitpython-developers/GitPython/issues/832>`_,
`#961 <https://github.com/gitpython-developers/GitPython/pull/961>`_)
* Added support for parsing Git internal date format (@<unix timestamp> <timezone offset>)
(`#965 <https://github.com/gitpython-developers/GitPython/pull/965>`_)
* Removed Python 2 and < 3.3 compatibility shims
(`#979 <https://github.com/gitpython-developers/GitPython/pull/979>`_)
* Fixed GitDB (gitdb2) requirement version specifier formatting in requirements.txt
(`#979 <https://github.com/gitpython-developers/GitPython/pull/979>`_)
3.0.5 - Bugfixes
=============================================
see the following for details:
https://github.com/gitpython-developers/gitpython/milestone/32?closed=1
3.0.4 - Bugfixes
=============================================
see the following for details:
https://github.com/gitpython-developers/gitpython/milestone/31?closed=1
3.0.3 - Bugfixes
=============================================
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/30?closed=1
3.0.2 - Bugfixes
=============================================
* fixes an issue with installation
3.0.1 - Bugfixes and performance improvements
=============================================
* Fix a `performance regression <https://github.com/gitpython-developers/GitPython/issues/906>`__ which could make certain workloads 50% slower
* Add `currently_rebasing_on` method on `Repo`, see `the PR <https://github.com/gitpython-developers/GitPython/pull/903/files#diff-c276fc3c4df38382ec884e59657b869dR1065>`__
* Fix incorrect `requirements.txt` which could lead to broken installations, see this `issue <https://github.com/gitpython-developers/GitPython/issues/908>`__ for details.
3.0.0 - Remove Python 2 support
===============================
Motivation for this is a patch which improves unicode handling when dealing with filesystem paths.
Python 2 compatibility was introduced to deal with differences, and I thought it would be a good idea
to 'just' drop support right now, mere 5 months away from the official maintenance stop of python 2.7.
The underlying motivation clearly is my anger when thinking python and unicode, which was a hassle from the
start, at least in a codebase as old as GitPython, which totally doesn't handle encodings correctly in many cases.
Having migrated to using `Rust` exclusively for tooling, I still see that correct handling of encodings isn't entirely
trivial, but at least `Rust` makes clear what has to be done at compile time, allowing to write software that is pretty
much guaranteed to work once it compiles.
Again, my apologies if removing Python 2 support caused inconveniences, please see release 2.1.13 which returns it.
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/27?closed=1
or run have a look at the difference between tags v2.1.12 and v3.0.0:
https://github.com/gitpython-developers/GitPython/compare/2.1.12...3.0.0.
2.1.15
======
* Fixed GitDB (gitdb2) requirement version specifier formatting in requirements.txt
(Backported from `#979 <https://github.com/gitpython-developers/GitPython/pull/979>`_)
* Restricted GitDB (gitdb2) version requirement to < 3
(`#897 <https://github.com/gitpython-developers/GitPython/issues/897>`_)
2.1.14
======
* Fixed handling of 0 when transforming kwargs into Git command arguments
(Backported from `#899 <https://github.com/gitpython-developers/GitPython/pull/899>`_)
2.1.13 - Bring back Python 2.7 support
======================================
My apologies for any inconvenience this may have caused. Following semver, backward incompatible changes
will be introduced in a minor version.
2.1.12 - Bugfixes and Features
==============================
* Multi-value support and interface improvements for Git configuration. Thanks to A. Jesse Jiryu Davis.
or run have a look at the difference between tags v2.1.11 and v2.1.12:
https://github.com/gitpython-developers/GitPython/compare/2.1.11...2.1.12
2.1.11 - Bugfixes
=================
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/26?closed=1
or run have a look at the difference between tags v2.1.10 and v2.1.11:
https://github.com/gitpython-developers/GitPython/compare/2.1.10...2.1.11
2.1.10 - Bugfixes
=================
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/25?closed=1
or run have a look at the difference between tags v2.1.9 and v2.1.10:
https://github.com/gitpython-developers/GitPython/compare/2.1.9...2.1.10
2.1.9 - Dropping support for Python 2.6
=======================================
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/24?closed=1
or run have a look at the difference between tags v2.1.8 and v2.1.9:
https://github.com/gitpython-developers/GitPython/compare/2.1.8...2.1.9
2.1.8 - bugfixes
====================================
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/23?closed=1
or run have a look at the difference between tags v2.1.7 and v2.1.8:
https://github.com/gitpython-developers/GitPython/compare/2.1.7...2.1.8
2.1.6 - bugfixes
====================================
* support for worktrees
2.1.3 - Bugfixes
====================================
All issues and PRs can be viewed in all detail when following this URL:
https://github.com/gitpython-developers/GitPython/milestone/21?closed=1
2.1.1 - Bugfixes
====================================
All issues and PRs can be viewed in all detail when following this URL:
https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone%3A%22v2.1.1+-+Bugfixes%22
2.1.0 - Much better windows support!
====================================
Special thanks to @ankostis, who made this release possible (nearly) single-handedly.
GitPython is run by its users, and their PRs make all the difference, they keep
GitPython relevant. Thank you all so much for contributing !
Notable fixes
-------------
* The `GIT_DIR` environment variable does not override the `path` argument when
initializing a `Repo` object anymore. However, if said `path` unset, `GIT_DIR`
will be used to fill the void.
All issues and PRs can be viewed in all detail when following this URL:
https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone%3A%22v2.1.0+-+proper+windows+support%22
2.0.9 - Bugfixes
=============================
* `tag.commit` will now resolve commits deeply.
* `Repo` objects can now be pickled, which helps with multi-processing.
* `Head.checkout()` now deals with detached heads, which is when it will return
the `HEAD` reference instead.
* `DiffIndex.iter_change_type(...)` produces better results when diffing
2.0.8 - Features and Bugfixes
=============================
* `DiffIndex.iter_change_type(...)` produces better results when diffing
an index against the working tree.
* `Repo().is_dirty(...)` now supports the `path` parameter, to specify a single
path by which to filter the output. Similar to `git status <path>`
* Symbolic refs created by this library will now be written with a newline
character, which was previously missing.
* `blame()` now properly preserves multi-line commit messages.
* No longer corrupt ref-logs by writing multi-line comments into them.
2.0.7 - New Features
====================
* `IndexFile.commit(...,skip_hooks=False)` added. This parameter emulates the
behaviour of `--no-verify` on the command-line.
2.0.6 - Fixes and Features
==========================
* Fix: remote output parser now correctly matches refs with non-ASCII
chars in them
* API: Diffs now have `a_rawpath`, `b_rawpath`, `raw_rename_from`,
`raw_rename_to` properties, which are the raw-bytes equivalents of their
unicode path counterparts.
* Fix: TypeError about passing keyword argument to string decode() on
Python 2.6.
* Feature: `setUrl API on Remotes <https://github.com/gitpython-developers/GitPython/pull/446#issuecomment-224670539>`__
2.0.5 - Fixes
=============
* Fix: parser of fetch info lines choked on some legitimate lines
2.0.4 - Fixes
=============
* Fix: parser of commit object data is now robust against cases where
commit object contains invalid bytes. The invalid characters are now
replaced rather than choked on.
* Fix: non-ASCII paths are now properly decoded and returned in
``.diff()`` output
* Fix: `RemoteProgress` will now strip the ', ' prefix or suffix from messages.
* API: Remote.[fetch|push|pull](...) methods now allow the ``progress`` argument to
be a callable. This saves you from creating a custom type with usually just one
implemented method.
2.0.3 - Fixes
=============
* Fix: bug in ``git-blame --incremental`` output parser that broken when
commit messages contained ``\r`` characters
* Fix: progress handler exceptions are not caught anymore, which would usually just hide bugs
previously.
* Fix: The `Git.execute` method will now redirect `stdout` to `devnull` if `with_stdout` is false,
which is the intended behaviour based on the parameter's documentation.
2.0.2 - Fixes
=============
* Fix: source package does not include \*.pyc files
* Fix: source package does include doc sources
2.0.1 - Fixes
=============
* Fix: remote output parser now correctly matches refs with "@" in them
2.0.0 - Features
================
Please note that due to breaking changes, we have to increase the major version.
* **IMPORTANT**: This release drops support for python 2.6, which is
officially deprecated by the python maintainers.
* **CRITICAL**: `Diff` objects created with patch output will now not carry
the --- and +++ header lines anymore. All diffs now start with the
@@ header line directly. Users that rely on the old behaviour can now
(reliably) read this information from the a_path and b_path properties
without having to parse these lines manually.
* `Commit` now has extra properties `authored_datetime` and
`committer_datetime` (to get Python datetime instances rather than
timestamps)
* `Commit.diff()` now supports diffing the root commit via
`Commit.diff(NULL_TREE)`.
* `Repo.blame()` now respects `incremental=True`, supporting incremental
blames. Incremental blames are slightly faster since they don't include
the file's contents in them.
* Fix: `Diff` objects created with patch output will now have their
`a_path` and `b_path` properties parsed out correctly. Previously, some
values may have been populated incorrectly when a file was added or
deleted.
* Fix: diff parsing issues with paths that contain "unsafe" chars, like
spaces, tabs, backslashes, etc.
1.0.2 - Fixes
=============
* IMPORTANT: Changed default object database of `Repo` objects to `GitCmdObjectDB`. The pure-python implementation
used previously usually fails to release its resources (i.e. file handles), which can lead to problems when working
with large repositories.
* CRITICAL: fixed incorrect `Commit` object serialization when authored or commit date had timezones which were not
divisiblej by 3600 seconds. This would happen if the timezone was something like `+0530` for instance.
* A list of all additional fixes can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v1.0.2+-+Fixes%22+is%3Aclosed>`__
* CRITICAL: `Tree.cache` was removed without replacement. It is technically impossible to change individual trees and expect their serialization results to be consistent with what *git* expects. Instead, use the `IndexFile` facilities to adjust the content of the staging area, and write it out to the respective tree objects using `IndexFile.write_tree()` instead.
1.0.1 - Fixes
=============
* A list of all issues can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v1.0.1+-+Fixes%22+is%3Aclosed>`__
1.0.0 - Notes
=============
This version is equivalent to v0.3.7, but finally acknowledges that GitPython is stable and production ready.
It follows the `semantic version scheme <http://semver.org>`_, and thus will not break its existing API unless it goes 2.0.
0.3.7 - Fixes
=============
* `IndexFile.add()` will now write the index without any extension data by default. However, you may override this behaviour with the new `write_extension_data` keyword argument.
- Renamed `ignore_tree_extension_data` keyword argument in `IndexFile.write(...)` to `ignore_extension_data`
* If the git command executed during `Remote.push(...)|fetch(...)` returns with an non-zero exit code and GitPython didn't
obtain any head-information, the corresponding `GitCommandError` will be raised. This may break previous code which expected
these operations to never raise. However, that behaviour is undesirable as it would effectively hide the fact that there
was an error. See `this issue <https://github.com/gitpython-developers/GitPython/issues/271>`__ for more information.
* If the git executable can't be found in the PATH or at the path provided by `GIT_PYTHON_GIT_EXECUTABLE`, this is made
obvious by throwing `GitCommandNotFound`, both on unix and on windows.
- Those who support **GUI on windows** will now have to set `git.Git.USE_SHELL = True` to get the previous behaviour.
* A list of all issues can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.7+-+Fixes%22+is%3Aclosed>`__
0.3.6 - Features
================
* **DOCS**
* special members like `__init__` are now listed in the API documentation
* tutorial section was revised entirely, more advanced examples were added.
* **POSSIBLY BREAKING CHANGES**
* As `rev_parse` will now throw `BadName` as well as `BadObject`, client code will have to catch both exception types.
* Repo.working_tree_dir now returns None if it is bare. Previously it raised AssertionError.
* IndexFile.add() previously raised AssertionError when paths where used with bare repository, now it raises InvalidGitRepositoryError
* Added `Repo.merge_base()` implementation. See the `respective issue on GitHub <https://github.com/gitpython-developers/GitPython/issues/169>`__
* `[include]` sections in git configuration files are now respected
* Added `GitConfigParser.rename_section()`
* Added `Submodule.rename()`
* A list of all issues can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.6+-+Features%22+>`__
0.3.5 - Bugfixes
================
* push/pull/fetch operations will not block anymore
* diff() can now properly detect renames, both in patch and raw format. Previously it only worked when create_patch was True.
* repo.odb.update_cache() is now called automatically after fetch and pull operations. In case you did that in your own code, you might want to remove your line to prevent a double-update that causes unnecessary IO.
* `Repo(path)` will not automatically search upstream anymore and find any git directory on its way up. If you need that behaviour, you can turn it back on using the new `search_parent_directories=True` flag when constructing a `Repo` object.
* IndexFile.commit() now runs the `pre-commit` and `post-commit` hooks. Verified to be working on posix systems only.
* A list of all fixed issues can be found here: https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.5+-+bugfixes%22+
0.3.4 - Python 3 Support
========================
* Internally, hexadecimal SHA1 are treated as ascii encoded strings. Binary SHA1 are treated as bytes.
* Id attribute of Commit objects is now `hexsha`, instead of `binsha`. The latter makes no sense in python 3 and I see no application of it anyway besides its artificial usage in test cases.
* **IMPORTANT**: If you were using the config_writer(), you implicitly relied on __del__ to work as expected to flush changes. To be sure changes are flushed under PY3, you will have to call the new `release()` method to trigger a flush. For some reason, __del__ is not called necessarily anymore when a symbol goes out of scope.
* The `Tree` now has a `.join('name')` method which is equivalent to `tree / 'name'`
0.3.3
=====
* When fetching, pulling or pushing, and an error occurs, it will not be reported on stdout anymore. However, if there is a fatal error, it will still result in a GitCommandError to be thrown. This goes hand in hand with improved fetch result parsing.
* Code Cleanup (in preparation for python 3 support)
* Applied autopep8 and cleaned up code
* Using python logging module instead of print statements to signal certain kinds of errors
0.3.2.1
=======
* `Fix for #207 <https://github.com/gitpython-developers/GitPython/issues/207>`_
0.3.2
=====
* Release of most recent version as non-RC build, just to allow pip to install the latest version right away.
* Have a look at the milestones (https://github.com/gitpython-developers/GitPython/milestones) to see what's next.
0.3.2 RC1
=========
* **git** command wrapper
* Added ``version_info`` property which returns a tuple of integers representing the installed git version.
* Added GIT_PYTHON_GIT_EXECUTABLE environment variable, which can be used to set the desired git executable to be used. despite of what would be found in the path.
* **Blob** Type
* Added mode constants to ease the manual creation of blobs
* **IterableList**
* Added __contains__ and __delitem__ methods
* **More Changes**
* Configuration file parsing is more robust. It should now be able to handle everything that the git command can parse as well.
* The progress parsing was updated to support git 1.7.0.3 and newer. Previously progress was not enabled for the git command or only worked with ssh in case of older git versions.
* Parsing of tags was improved. Previously some parts of the name could not be parsed properly.
* The rev-parse pure python implementation now handles branches correctly if they look like hexadecimal sha's.
* GIT_PYTHON_TRACE is now set on class level of the Git type, previously it was a module level global variable.
* GIT_PYTHON_GIT_EXECUTABLE is a class level variable as well.
0.3.1 Beta 2
============
* Added **reflog support** ( reading and writing )
* New types: ``RefLog`` and ``RefLogEntry``
* Reflog is maintained automatically when creating references and deleting them
* Non-intrusive changes to ``SymbolicReference``, these don't require your code to change. They allow to append messages to the reflog.
* ``abspath`` property added, similar to ``abspath`` of Object instances
* ``log()`` method added
* ``log_append(...)`` method added
* ``set_reference(...)`` method added (reflog support)
* ``set_commit(...)`` method added (reflog support)
* ``set_object(...)`` method added (reflog support)
* **Intrusive Changes** to ``Head`` type
* ``create(...)`` method now supports the reflog, but will not raise ``GitCommandError`` anymore as it is a pure python implementation now. Instead, it raises ``OSError``.
* **Intrusive Changes** to ``Repo`` type
* ``create_head(...)`` method does not support kwargs anymore, instead it supports a logmsg parameter
* Repo.rev_parse now supports the [ref]@{n} syntax, where *n* is the number of steps to look into the reference's past
* **BugFixes**
* Removed incorrect ORIG_HEAD handling
* **Flattened directory** structure to make development more convenient.
* .. note:: This alters the way projects using git-python as a submodule have to adjust their sys.path to be able to import git-python successfully.
* Misc smaller changes and bugfixes
0.3.1 Beta 1
============
* Full Submodule-Support
* Added unicode support for author names. Commit.author.name is now unicode instead of string.
* Head Type changes
* config_reader() & config_writer() methods added for access to head specific options.
* tracking_branch() & set_tracking_branch() methods added for easy configuration of tracking branches.
0.3.0 Beta 2
============
* Added python 2.4 support
0.3.0 Beta 1
============
Renamed Modules
---------------
* For consistency with naming conventions used in sub-modules like gitdb, the following modules have been renamed
* git.utils -> git.util
* git.errors -> git.exc
* git.objects.utils -> git.objects.util
General
-------
* Object instances, and everything derived from it, now use binary sha's internally. The 'sha' member was removed, in favor of the 'binsha' member. An 'hexsha' property is available for convenient conversions. They may only be initialized using their binary shas, reference names or revision specs are not allowed anymore.
* IndexEntry instances contained in IndexFile.entries now use binary sha's. Use the .hexsha property to obtain the hexadecimal version. The .sha property was removed to make the use of the respective sha more explicit.
* If objects are instantiated explicitly, a binary sha is required to identify the object, where previously any rev-spec could be used. The ref-spec compatible version still exists as Object.new or Repo.commit|Repo.tree respectively.
* The .data attribute was removed from the Object type, to obtain plain data, use the data_stream property instead.
* ConcurrentWriteOperation was removed, and replaced by LockedFD
* IndexFile.get_entries_key was renamed to entry_key
* IndexFile.write_tree: removed missing_ok keyword, its always True now. Instead of raising GitCommandError it raises UnmergedEntriesError. This is required as the pure-python implementation doesn't support the missing_ok keyword yet.
* diff.Diff.null_hex_sha renamed to NULL_HEX_SHA, to be conforming with the naming in the Object base class
0.2 Beta 2
===========
* Commit objects now carry the 'encoding' information of their message. It wasn't parsed previously, and defaults to UTF-8
* Commit.create_from_tree now uses a pure-python implementation, mimicking git-commit-tree
0.2
=====
General
-------
* file mode in Tree, Blob and Diff objects now is an int compatible to definitions
in the stat module, allowing you to query whether individual user, group and other
read, write and execute bits are set.
* Adjusted class hierarchy to generally allow comparison and hash for Objects and Refs
* Improved Tag object which now is a Ref that may contain a tag object with additional
Information
* id_abbrev method has been removed as it could not assure the returned short SHA's
where unique
* removed basename method from Objects with path's as it replicated features of os.path
* from_string and list_from_string methods are now private and were renamed to
_from_string and _list_from_string respectively. As part of the private API, they
may change without prior notice.
* Renamed all find_all methods to list_items - this method is part of the Iterable interface
that also provides a more efficients and more responsive iter_items method
* All dates, like authored_date and committer_date, are stored as seconds since epoch
to consume less memory - they can be converted using time.gmtime in a more suitable
presentation format if needed.
* Named method parameters changed on a wide scale to unify their use. Now git specific
terms are used everywhere, such as "Reference" ( ref ) and "Revision" ( rev ).
Previously multiple terms where used making it harder to know which type was allowed
or not.
* Unified diff interface to allow easy diffing between trees, trees and index, trees
and working tree, index and working tree, trees and index. This closely follows
the git-diff capabilities.
* Git.execute does not take the with_raw_output option anymore. It was not used
by anyone within the project and False by default.
Item Iteration
--------------
* Previously one would return and process multiple items as list only which can
hurt performance and memory consumption and reduce response times.
iter_items method provide an iterator that will return items on demand as parsed
from a stream. This way any amount of objects can be handled.
* list_items method returns IterableList allowing to access list members by name
objects Package
----------------
* blob, tree, tag and commit module have been moved to new objects package. This should
not affect you though unless you explicitly imported individual objects. If you just
used the git package, names did not change.
Blob
----
* former 'name' member renamed to path as it suits the actual data better
GitCommand
-----------
* git.subcommand call scheme now prunes out None from the argument list, allowing
to be called more comfortably as None can never be a valid to the git command
if converted to a string.
* Renamed 'git_dir' attribute to 'working_dir' which is exactly how it is used
Commit
------
* 'count' method is not an instance method to increase its ease of use
* 'name_rev' property returns a nice name for the commit's sha
Config
------
* The git configuration can now be read and manipulated directly from within python
using the GitConfigParser
* Repo.config_reader() returns a read-only parser
* Repo.config_writer() returns a read-write parser
Diff
----
* Members a a_commit and b_commit renamed to a_blob and b_blob - they are populated
with Blob objects if possible
* Members a_path and b_path removed as this information is kept in the blobs
* Diffs are now returned as DiffIndex allowing to more quickly find the kind of
diffs you are interested in
Diffing
-------
* Commit and Tree objects now support diffing natively with a common interface to
compare against other Commits or Trees, against the working tree or against the index.
Index
-----
* A new Index class allows to read and write index files directly, and to perform
simple two and three way merges based on an arbitrary index.
References
------------
* References are object that point to a Commit
* SymbolicReference are a pointer to a Reference Object, which itself points to a specific
Commit
* They will dynamically retrieve their object at the time of query to assure the information
is actual. Recently objects would be cached, hence ref object not be safely kept
persistent.
Repo
----
* Moved blame method from Blob to repo as it appeared to belong there much more.
* active_branch method now returns a Head object instead of a string with the name
of the active branch.
* tree method now requires a Ref instance as input and defaults to the active_branch
instead of master
* is_dirty now takes additional arguments allowing fine-grained control about what is
considered dirty
* Removed the following methods:
- 'log' method as it as effectively the same as the 'commits' method
- 'commits_since' as it is just a flag given to rev-list in Commit.iter_items
- 'commit_count' as it was just a redirection to the respective commit method
- 'commits_between', replaced by a note on the iter_commits method as it can achieve the same thing
- 'commit_delta_from' as it was a very special case by comparing two different repjrelated repositories, i.e. clones, git-rev-list would be sufficient to find commits that would need to be transferred for example.
- 'create' method which equals the 'init' method's functionality
- 'diff' - it returned a mere string which still had to be parsed
- 'commit_diff' - moved to Commit, Tree and Diff types respectively
* Renamed the following methods:
- commits to iter_commits to improve the performance, adjusted signature
- init_bare to init, implying less about the options to be used
- fork_bare to clone, as it was to represent general clone functionality, but implied
a bare clone to be more versatile
- archive_tar_gz and archive_tar and replaced by archive method with different signature
* 'commits' method has no max-count of returned commits anymore, it now behaves like git-rev-list
* The following methods and properties were added
- 'untracked_files' property, returning all currently untracked files
- 'head', creates a head object
- 'tag', creates a tag object
- 'iter_trees' method
- 'config_reader' method
- 'config_writer' method
- 'bare' property, previously it was a simple attribute that could be written
* Renamed the following attributes
- 'path' is now 'git_dir'
- 'wd' is now 'working_dir'
* Added attribute
- 'working_tree_dir' which may be None in case of bare repositories
Remote
------
* Added Remote object allowing easy access to remotes
* Repo.remotes lists all remotes
* Repo.remote returns a remote of the specified name if it exists
Test Framework
--------------
* Added support for common TestCase base class that provides additional functionality
to receive repositories tests can also write to. This way, more aspects can be
tested under real-world ( un-mocked ) conditions.
Tree
----
* former 'name' member renamed to path as it suits the actual data better
* added traverse method allowing to recursively traverse tree items