3.1.50

What's Changed

• Bump https://github.com/astral-sh/ruff-pre-commit from v0.15.8 to 0.15.12 in the pre-commit group by @dependabot[bot] in #2140
• Bump git/ext/gitdb from 335c0f6 to 53c94d6 by @dependabot[bot] in #2141
• Fix Repo() autodiscovery in linked worktrees when GIT_DIR is set by @meliezer in #2128
• Validate config key names before writing by @Byron in #2142

New Contributors

• @meliezer made their first contribution in #2128

Full Changelog: 3.1.49...3.1.50

3.1.49 - Security

What's Changed

• reject control chars in written values in configuration by @Byron in #2137
• Improve pure Python rev-parse coverage and behavior by @Copilot in #2136

Full Changelog: 3.1.48...3.1.49

3.1.48 - Security

Accidentally deleted the previous GH release, it did mention the advisory this fixes.

What's Changed

• prevent out-of-repo access when manipulating references. by @Byron in #2134

Full Changelog: 3.1.47...3.1.48

3.1.47 - with security fixes

Advisories

• GHSA-rpm5-65cw-6hj4
• GHSA-x2qx-6953-8485

What's Changed

• Prepare next release by @Byron in #2095
• Bump git/ext/gitdb from 335c0f6 to 4c63ee6 by @dependabot[bot] in #2096
• DOC: README Add urls and updated a relative url by @Timour-Ilyas in #2098
• Fix GitConfigParser ignoring multiple [include] path entries by @daniel7an in #2100
• Switch back from Alpine to Debian for WSL by @EliahKagan in #2108
• Bump git/ext/gitdb from 4c63ee6 to 5c1b303 by @dependabot[bot] in #2106
• Run gc.collect() twice in test_rename on Python 3.12 by @EliahKagan in #2109
• fix: guard AutoInterrupt terminate during interpreter shutdown by @lweyrich1 in #2105
• Improve CI infrastructure for pre-commit by @EliahKagan in #2110
• Bump the pre-commit group with 5 updates by @dependabot[bot] in #2111
• Upgrade Sphinx for 3.14 support; drop doc build support on 3.8; test 3.14 by @EliahKagan in #2112
• Fix Repo.active_branch resolution for reftable-backed repositories by @Copilot in #2114
• docs: warn about GitDB performance with large commits by @mvanhorn in #2115
• cmd: fix kwarg formatting in docstring example by @UweSchwaeke in #2117
• Bump https://github.com/astral-sh/ruff-pre-commit from v0.15.5 to 0.15.8 in the pre-commit group by @dependabot[bot] in #2122
• Add trailer support for commit creation by @Krishnachaitanyakc in #2116
• Harden commit trailer subprocess handling and align trailer I/O paths by @Copilot in #2125
• git.cmd.Git.execute(..): fix with_stdout=False by @ngie-eign in #2126
• Make sure that multi-options are checked after splitting them with shlex by @Byron in #2130
• Block unsafe underscored git kwargs / Fix for GHSA-rpm5-65cw-6hj4 by @WesR in #2131

New Contributors

• @Timour-Ilyas made their first contribution in #2098
• @daniel7an made their first contribution in #2100
• @lweyrich1 made their first contribution in #2105
• @Copilot made their first contribution in #2114
• @mvanhorn made their first contribution in #2115
• @UweSchwaeke made their first contribution in #2117
• @Krishnachaitanyakc made their first contribution in #2116
• @ngie-eign made their first contribution in #2126
• @WesR made their first contribution in #2131

Full Changelog: 3.1.46...3.1.47

3.1.46

What's Changed

• Prepare a new release by @Byron in #2063
• Bump actions/checkout from 4 to 5 by @dependabot[bot] in #2067
• Bump git/ext/gitdb from 335c0f6 to 39d7dbf by @dependabot[bot] in #2068
• Bump actions/setup-python from 5 to 6 by @dependabot[bot] in #2070
• Bump git/ext/gitdb from 39d7dbf to f8fdfec by @dependabot[bot] in #2071
• Fix type hint for SymbolicReference.reference property by @emmanuel-ferdman in #2074
• feat: Add support for hasconfig git rule. by @bvanelli in #2075
• Bump github/codeql-action from 3 to 4 by @dependabot[bot] in #2076
• Use actual return type in annotation for method submodule_update by @extrwi in #2078
• Bump git/ext/gitdb from f8fdfec to 65321a2 by @dependabot[bot] in #2082
• Preliminary support for index format v3 by @blahgeek in #2081
• Bump actions/checkout from 5 to 6 by @dependabot[bot] in #2084
• Pin mypy==1.18.2 by @George-Ogden in #2087
• Respect os.Pathlike by @George-Ogden in #2086
• Bump git/ext/gitdb from 65321a2 to 4c63ee6 by @dependabot[bot] in #2093
• Join Pathlike Object to Tree by @George-Ogden in #2094

New Contributors

• @emmanuel-ferdman made their first contribution in #2074
• @bvanelli made their first contribution in #2075
• @extrwi made their first contribution in #2078
• @blahgeek made their first contribution in #2081
• @George-Ogden made their first contribution in #2087

Full Changelog: 3.1.45...3.1.46

3.1.45

What's Changed

• Fix various version-related CI breakages by @EliahKagan in #1987
• Do some CI cleanup to make reports clearer and future changes easier by @EliahKagan in #1989
• Affirm that gitdb and smmap advisories can also be created by @EliahKagan in #1991
• Fix links to gitdb and smmap SECURITY.md files by @EliahKagan in #1992
• Test Python 3.13 regularly on Ubuntu and macOS on CI by @EliahKagan in #1990
• Repo.rev_parse: Handle ^{commit} correctly by @flichtenheld in #1996
• Fuzzing: Fix Broken Fuzz Test for Git Submodule Handling by @DaveLak in #1997
• Work around Cygwin CI failure #2004, except for test_installation by @EliahKagan in #2007
• Mark test_installation xfail on Cygwin CI by @EliahKagan in #2009
• IndexFile._to_relative_path - fix case where absolute path gets stripped of trailing slash by @kamilkozik7 in #2012
• Use WSL1 on CI by @EliahKagan in #2010
• Test free-threaded Python (but only on Linux) by @EliahKagan in #2011
• Use property decorator to support typing by @Andrej730 in #2015
• Fix some incorrect sphinx markups in the docstrings by @koyuki7w in #2018
• replace quansight-labs/setup-python with actions/setup-python by @ngoldbaum in #2019
• remove type assertions from util.py by @gcmarx in #2028
• correctly handle uname-cmd that doesn't point to an executable file by @gcmarx in #2026
• Use newer ruff style by @EliahKagan in #2031
• Have CodeQL scan GitHub Actions workflows as well as Python code by @EliahKagan in #2032
• Specify explicit contents: read workflow permissions by @EliahKagan in #2033
• Fix GitConfigParser not removing quotes from values by @betaboon in #2035
• Preserve quoted leading and trailing single-line config var whitespace by @EliahKagan in #2036
• Refactor Git.{AutoInterrupt,CatFileContentStream} nesting by @EliahKagan in #2037
• Fix Git.{AutoInterrupt,CatFileContentStream} static typing by @EliahKagan in #2039
• Fix CI mypy command on free-threaded Python by @EliahKagan in #2040
• Split Cygwin CI into non-performance and performance test jobs by @EliahKagan in #2042
• Express conditional setuptools requirement statically by @EliahKagan in #2043
• Fix ambiguous _safer_popen_windows comment by @EliahKagan in #2044
• Clarify USE_SHELL warning helper signature by @EliahKagan in #2045
• Test ConfigParser with whitespace outside the value by @EliahKagan in #2046
• Remove explicit empty "" handling in ConfigParser by @EliahKagan in #2047
• Various style improvements by @EliahKagan in #2049
• Don't remove quotes if \ or " are present inside by @EliahKagan in #2048
• fix updating submodules with relative urls by @david0 in #2051
• Run cat_file.py fixture without site customizations by @EliahKagan in #2052
• Fix Cygwin installation on CI for pip by @EliahKagan in #2053
• Fail test_installation on warnings, and remove deprecated license classifier by @EliahKagan in #2054
• Add clearer error version for unsupported index error by @tombedor in #2055
• Fix name collision by @NMertsch in #2060
• Allow relative path url in submodules for submodule_update by @t-webber in #2062

New Contributors

• @flichtenheld made their first contribution in #1996
• @kamilkozik7 made their first contribution in #2012
• @koyuki7w made their first contribution in #2018
• @ngoldbaum made their first contribution in #2019
• @gcmarx made their first contribution in #2028
• @betaboon made their first contribution in #2035
• @david0 made their first contribution in #2051
• @tombedor made their first contribution in #2055
• @NMertsch made their first contribution in #2060
• @t-webber made their first contribution in #2062

Full Changelog: 3.1.44...3.1.45

3.1.44

What's Changed

• Fix typo in _get_exe_extensions PATHEXT fallback by @EliahKagan in #1890
• Don't suppress pytest warning summaries by @EliahKagan in #1892
• Update the comment about --mixed and paths by @EliahKagan in #1894
• Fixed an error updating shallow submodules by @EduardTalanov in #1899
• Initial Migration of Fuzz Tests & Integration Scripts From the OSS-Fuzz Project Repo by @DaveLak in #1901
• Fuzzer Migration Follow-ups by @DaveLak in #1903
• Dockerize "Direct Execution of Fuzz Targets" by @DaveLak in #1904
• Fix Fuzzer Crash in ClusterFuzz Due to Missing Git Executable by @DaveLak in #1906
• Add GitPython's Standard License Header Comments to Shell Scripts by @DaveLak in #1907
• Fix IndexError in GitConfigParser When a Quoted Config Value Contains a Trailing New Line by @DaveLak in #1908
• Attempt 2 - Fix Missing Git Executable Causing ClusterFuzz Crash by @DaveLak in #1909
• Replace the Suboptimal fuzz_tree.py Harness With a Better Alternative by @DaveLak in #1910
• Add git.Blob Fuzz Target by @DaveLak in #1911
• lint: switch order Ruff's hooks fix -> format by @Borda in #1912
• Update OSS-Fuzz Scripts to Use New QA-Assets Repo Structure by @DaveLak in #1913
• Add Diff Fuzz Target by @DaveLak in #1914
• Instrument test utility functions to increase fuzzer efficiency by @DaveLak in #1915
• Add the .git subdir as another safe.directory on Cygwin CI by @EliahKagan in #1916
• Bump Vampire/setup-wsl from 3.0.0 to 3.1.0 by @dependabot in #1917
• Add Submodules Fuzz Target by @DaveLak in #1919
• Add graceful handling of expected exceptions in fuzz_submodule.py by @DaveLak in #1922
• precommit: enable validate-pyproject by @Borda in #1921
• typing fixes - DiffIndex generic type and IndexFile items by @Andrej730 in #1925
• Fix Improper Import Order Breaking fuzz_submodule Fuzzer by @DaveLak in #1926
• Fix iter_change_type diff renamed property to prevent warning by @kamilkrzyskow in #1918
• fixed doc to not faulty do #1924 by @zerothi in #1932
• fix: fix incoherent beginning whitespace by @cardoeng in #1933
• Change aliases to work around mypy issue. by @PatrickMassot in #1935
• precommit: enable end-of-file-fixer by @Borda in #1920
• lint: add typos check by @Borda in #1888
• Add type of change to files_dict of a commit by @JonasScharpf in #1943
• Enable Python 3.8 and 3.9 on M1 runners by @EliahKagan in #1944
• Use Alpine Linux in WSL on CI by @EliahKagan in #1945
• Remove the non-ARM macOS CI jobs by @EliahKagan in #1946
• Fix Several Bugs in the fuzz_submodule Causing a lot of False Alarms in the OSS-Fuzz Bug Tracker by @DaveLak in #1950
• Gracefully handle PermissionError exceptions that crash fuzzer by @DaveLak in #1951
• Fuzzing: Gracefully Handle Uninteresting Error to Fix OSS-Fuzz Issue by @DaveLak in #1952
• Update and adjust pre-commit hooks by @EliahKagan in #1953
• Upgrade sphinx to ~7.1.2 by @EliahKagan in #1954
• Don't support building documentation on Python 3.7 by @EliahKagan in #1956
• _to_relative_path to support mixing slashes and backslashes by @Andrej730 in #1961
• Update base.py by @alex20230721 in #1965
• Fix Fetch progress bar by @fvalette-ledger in #1971

New Contributors

• @EduardTalanov made their first contribution in #1899
• @DaveLak made their first contribution in #1901
• @Andrej730 made their first contribution in #1925
• @kamilkrzyskow made their first contribution in #1918
• @zerothi made their first contribution in #1932
• @cardoeng made their first contribution in #1933
• @PatrickMassot made their first contribution in #1935
• @JonasScharpf made their first contribution in #1943
• @alex20230721 made their first contribution in #1965
• @fvalette-ledger made their first contribution in #1971

Full Changelog: 3.1.43...3.1.44

3.1.43

Particularly Important Changes

These are likely to affect you, please do take a careful look.

• Issue and test deprecation warnings by @EliahKagan in #1886
• Fix version_info cache invalidation, typing, parsing, and serialization by @EliahKagan in #1838
• Document manual refresh path treatment by @EliahKagan in #1839
• Improve static typing and docstrings related to git object types by @EliahKagan in #1859

Other Changes

• Test in Docker with Alpine Linux on CI by @EliahKagan in #1826
• Build online docs (RTD) with -W and dependencies by @EliahKagan in #1843
• Suggest full-path refresh() in failure message by @EliahKagan in #1844
• repo.blame and repo.blame_incremental now accept None as the rev parameter. by @Gaubbe in #1846
• Make sure diff always uses the default diff driver when create_patch=True by @can-taslicukur in #1832
• Revise docstrings, comments, and a few messages by @EliahKagan in #1850
• Expand what is included in the API Reference by @EliahKagan in #1855
• Restore building of documentation downloads by @EliahKagan in #1856
• Revise type annotations slightly by @EliahKagan in #1860
• Updating regex pattern to handle unicode whitespaces. by @jcole-crowdstrike in #1853
• Use upgraded pip in test fixture virtual environment by @EliahKagan in #1864
• lint: replace flake8 with ruff check by @Borda in #1862
• lint: switch Black with ruff-format by @Borda in #1865
• Update readme and tox.ini for recent tooling changes by @EliahKagan in #1868
• Split tox lint env into three envs, all safe by @EliahKagan in #1870
• Slightly broaden Ruff, and update and clarify tool configuration by @EliahKagan in #1871
• Add a "doc" extra for documentation build dependencies by @EliahKagan in #1872
• Describe Submodule.__init__ parent_commit parameter by @EliahKagan in #1877
• Include TagObject in git.types.Tree_ish by @EliahKagan in #1878
• Improve Sphinx role usage, including linking Git manpages by @EliahKagan in #1879
• Replace all wildcard imports with explicit imports by @EliahKagan in #1880
• Clarify how tag objects are usually tree-ish and commit-ish by @EliahKagan in #1881

New Contributors

• @Gaubbe made their first contribution in #1846
• @can-taslicukur made their first contribution in #1832
• @jcole-crowdstrike made their first contribution in #1853
• @Borda made their first contribution in #1862

Full Changelog: 3.1.42...3.1.43

3.1.42

What's Changed

• Fix release link in changelog by @PeterJCLaw in #1795
• Remove test dependency on sumtypes library by @EliahKagan in #1798
• Pin Sphinx plugins to compatible versions by @EliahKagan in #1803
• fix: treeNotSorted issue by @et-repositories in #1799
• Remove git.util.NullHandler by @EliahKagan in #1807
• Clarify why GIT_PYTHON_GIT_EXECUTABLE may be set on failure by @EliahKagan in #1810
• Report actual attempted Git command when Git.refresh fails by @EliahKagan in #1812
• Don't suppress messages when logging is not configured by @EliahKagan in #1813
• Pin Python 3.9.16 on Cygwin CI by @EliahKagan in #1814
• Have initial refresh use a logger to warn by @EliahKagan in #1815
• Omit warning prefix in "Bad git executable" message by @EliahKagan in #1816
• Test with M1 macOS CI runner by @EliahKagan in #1817
• Bump pre-commit/action from 3.0.0 to 3.0.1 by @dependabot in #1818
• Bump Vampire/setup-wsl from 2.0.2 to 3.0.0 by @dependabot in #1819
• Remove deprecated section in README.md by @marcm-ml in #1823
• Keep temp files out of project dir and improve cleanup by @EliahKagan in #1825

New Contributors

• @PeterJCLaw made their first contribution in #1795
• @et-repositories made their first contribution in #1799
• @marcm-ml made their first contribution in #1823

Full Changelog: 3.1.41...3.1.42

3.1.41 - fix Windows security issue

The details about the Windows security issue can be found in this advisory.

Special thanks go to @EliahKagan who reported the issue and fixed it in a single stroke, while being responsible for an incredible amount of improvements that he contributed over the last couple of months ❤️.

What's Changed

• Add __all__ in git.exc by @EliahKagan in #1719
• Set submodule update cadence to weekly by @EliahKagan in #1721
• Never modify sys.path by @EliahKagan in #1720
• Bump git/ext/gitdb from 8ec2390 to ec58b7e by @dependabot in #1722
• Revise comments, docstrings, some messages, and a bit of code by @EliahKagan in #1725
• Use zero-argument super() by @EliahKagan in #1726
• Remove obsolete note in _iter_packed_refs by @EliahKagan in #1727
• Reorganize test_util and make xfail marks precise by @EliahKagan in #1729
• Clarify license and make module top comments more consistent by @EliahKagan in #1730
• Deprecate compat.is_, rewriting all uses by @EliahKagan in #1732
• Revise and restore some module docstrings by @EliahKagan in #1735
• Make the rmtree callback Windows-only by @EliahKagan in #1739
• List all non-passing tests in test summaries by @EliahKagan in #1740
• Document some minor subtleties in test_util.py by @EliahKagan in #1749
• Always read metadata files as UTF-8 in setup.py by @EliahKagan in #1748
• Test native Windows on CI by @EliahKagan in #1745
• Test macOS on CI by @EliahKagan in #1752
• Let close_fds be True on all platforms by @EliahKagan in #1753
• Fix IndexFile.from_tree on Windows by @EliahKagan in #1751
• Remove unused TASKKILL fallback in AutoInterrupt by @EliahKagan in #1754
• Don't return with operand when conceptually void by @EliahKagan in #1755
• Group .gitignore entries by purpose by @EliahKagan in #1758
• Adding dubious ownership handling by @marioaag in #1746
• Avoid brittle assumptions about preexisting temporary files in tests by @EliahKagan in #1759
• Overhaul noqa directives by @EliahKagan in #1760
• Clarify some Git.execute kill_after_timeout limitations by @EliahKagan in #1761
• Bump actions/setup-python from 4 to 5 by @dependabot in #1763
• Don't install black on Cygwin by @EliahKagan in #1766
• Extract all "import gc" to module level by @EliahKagan in #1765
• Extract remaining local "import gc" to module level by @EliahKagan in #1768
• Replace xfail with gc.collect in TestSubmodule.test_rename by @EliahKagan in #1767
• Enable CodeQL by @EliahKagan in #1769
• Replace some uses of the deprecated mktemp function by @EliahKagan in #1770
• Bump github/codeql-action from 2 to 3 by @dependabot in #1773
• Run some Windows environment variable tests only on Windows by @EliahKagan in #1774
• Fix TemporaryFileSwap regression where file_path could not be Path by @EliahKagan in #1776
• Improve hooks tests by @EliahKagan in #1777
• Fix if items of Index is of type PathLike by @stegm in #1778
• Better document IterableObj.iter_items and improve some subclasses by @EliahKagan in #1780
• Revert "Don't install black on Cygwin" by @EliahKagan in #1783
• Add missing pip in $PATH on Cygwin CI by @EliahKagan in #1784
• Shorten Iterable docstrings and put IterableObj first by @EliahKagan in #1785
• Fix incompletely revised Iterable/IterableObj docstrings by @EliahKagan in #1786
• Pre-deprecate setting Git.USE_SHELL by @EliahKagan in #1782
• Deprecate Git.USE_SHELL by @EliahKagan in #1787
• In handle_process_output don't forward finalizer result by @EliahKagan in #1788
• Fix mypy warning "Missing return statement" by @EliahKagan in #1789
• Fix two remaining Windows untrusted search path cases by @EliahKagan in #1792

New Contributors

• @marioaag made their first contribution in #1746
• @stegm made their first contribution in #1778

Full Changelog: 3.1.40...3.1.41