Skip to content

chore: pin GitPython for release bump #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leongdl merged 1 commit into from
Aug 25, 2026
+2 −1
Merged

chore: pin GitPython for release bump #339

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion requirements-release.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
python-semantic-release == 10.6.*
python-semantic-release == 10.6.*
GitPython == 3.1.59

@github-actions github-actions Bot Aug 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitPython is not imported anywhere in this repo (grep -rn "import git" finds nothing) — it is a transitive dependency of python-semantic-release. Hard-pinning a transitive dep to an exact patch version has two downsides worth weighing:

  1. Resolver fragility. If a future python-semantic-release 10.6.x tightens its GitPython range past 3.1.59, pip install -r requirements-release.txt in the release env (hatch.toml:40) fails outright rather than resolving. The release-bump job then breaks for a reason unrelated to this repo.
  2. No patch uptake. GitPython has a history of security advisories (e.g. CVE-2022-24439, CVE-2023-40590, CVE-2023-41040 — untrusted search path / argument injection). An == pin means a fixed patch release will not be picked up until someone edits this line by hand.

Every other requirement in this repo uses a minor-series wildcard (python-semantic-release == 10.6.*, and all of requirements-testing.txt). Suggest matching that convention:

GitPython == 3.1.*

If an exact pin is deliberate — i.e. a specific GitPython release broke the bump — please add a short comment naming the breakage (as requirements-testing.txt:8-9 does for black), so a future reader knows when the pin can be relaxed. The commit message ("chore: pin GitPython for release bump") does not record the reason.

Loading