Gitpython

Particularly Important Changes

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

* Issue and test deprecation warnings by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1886
* Fix version_info cache invalidation, typing, parsing, and serialization by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1838
* Document manual refresh path treatment by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1839
* Improve static typing and docstrings related to git object types by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1859

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

New Contributors
* Gaubbe made their first contribution in https://github.com/gitpython-developers/GitPython/pull/1846
* can-taslicukur made their first contribution in https://github.com/gitpython-developers/GitPython/pull/1832
* jcole-crowdstrike made their first contribution in https://github.com/gitpython-developers/GitPython/pull/1853
* Borda made their first contribution in https://github.com/gitpython-developers/GitPython/pull/1862

**Full Changelog**: https://github.com/gitpython-developers/GitPython/compare/3.1.42...3.1.43

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

New Contributors
* PeterJCLaw made their first contribution in https://github.com/gitpython-developers/GitPython/pull/1795
* et-repositories made their first contribution in https://github.com/gitpython-developers/GitPython/pull/1799
* marcm-ml made their first contribution in https://github.com/gitpython-developers/GitPython/pull/1823

**Full Changelog**: https://github.com/gitpython-developers/GitPython/compare/3.1.41...3.1.42

The details about the Windows security issue [can be found in this advisory](https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-2mqj-m65w-jghx).

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

New Contributors
* marioaag made their first contribution in https://github.com/gitpython-developers/GitPython/pull/1746
* stegm made their first contribution in https://github.com/gitpython-developers/GitPython/pull/1778

**Full Changelog**: https://github.com/gitpython-developers/GitPython/compare/3.1.40...3.1.41

What's Changed
* Add missing info in Submodule.remove docstring by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1714
* Have init script clone submodules unconditionally by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1715


**Full Changelog**: https://github.com/gitpython-developers/GitPython/compare/3.1.38...3.1.40

What's Changed
* Add missing assert keywords by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1678
* Make clear every test's status in every CI run by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1679
* Fix new link to license in readme by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1680
* Drop unneeded flake8 suppressions by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1681
* Update instructions and test helpers for git-daemon by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1684
* Fix Git.execute shell use and reporting bugs by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1687
* No longer allow CI to select a prerelease for 3.12 by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1689
* Clarify Git.execute and Popen arguments by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1688
* Ask git where its daemon is and use that by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1697
* Fix bugs affecting exception wrapping in rmtree callback by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1700
* Fix dynamically-set __all__ variable by DeflateAwning in https://github.com/gitpython-developers/GitPython/pull/1659
* Fix small 1662 regression due to 1659 by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1701
* Drop obsolete info on yanking from security policy by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1703
* Have Dependabot offer submodule updates by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1702
* Bump git/ext/gitdb from `49c3178` to `8ec2390` by dependabot in https://github.com/gitpython-developers/GitPython/pull/1704
* Bump git/ext/gitdb from `8ec2390` to `6a22706` by dependabot in https://github.com/gitpython-developers/GitPython/pull/1705
* Update readme for milestone-less releasing by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1707
* Run Cygwin CI workflow commands in login shells by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1709

New Contributors
* DeflateAwning made their first contribution in https://github.com/gitpython-developers/GitPython/pull/1659

**Full Changelog**: https://github.com/gitpython-developers/GitPython/compare/3.1.37...3.1.38

What's Changed
* Improve Python version and OS compatibility, fixing deprecations by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1654
* Better document env_case test/fixture and cwd by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1657
* Remove spurious executable permissions by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1658
* Fix up checks in Makefile and make them portable by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1661
* Fix URLs that were redirecting to another license by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1662
* Assorted small fixes/improvements to root dir docs by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1663
* Use venv instead of virtualenv in test_installation by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1664
* Omit py_modules in setup by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1665
* Don't track code coverage temporary files by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1666
* Configure tox by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1667
* Format tests with black and auto-exclude untracked paths by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1668
* Upgrade and broaden flake8, fixing style problems and bugs by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1673
* Fix rollback bug in SymbolicReference.set_reference by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1675
* Remove `NoEffect` annotations by EliahKagan in https://github.com/gitpython-developers/GitPython/pull/1677
* Add more checks for the validity of refnames by facutuesca in https://github.com/gitpython-developers/GitPython/pull/1672


**Full Changelog**: https://github.com/gitpython-developers/GitPython/compare/3.1.36...3.1.37