Skip to content

chore: pin GitPython for release bump - #339

Merged
leongdl merged 1 commit into
OpenJobDescription:mainlinefrom
AlexTranAmz:pin-gitPython
Aug 25, 2026
Merged

chore: pin GitPython for release bump#339
leongdl merged 1 commit into
OpenJobDescription:mainlinefrom
AlexTranAmz:pin-gitPython

Conversation

@AlexTranAmz

Copy link
Copy Markdown
Contributor

python-semantic-release/python-semantic-release#1477 - GitPython break semantic, pin to an older version pending fixes from upstream

@AlexTranAmz
AlexTranAmz requested a review from a team as a code owner August 25, 2026 21:42
Signed-off-by: AlexTranAmz <167144297+AlexTranAmz@users.noreply.github.com>
@leongdl
leongdl enabled auto-merge (rebase) August 25, 2026 21:55
@leongdl
leongdl merged commit 12816ad into OpenJobDescription:mainline Aug 25, 2026
30 of 31 checks passed
@AlexTranAmz
AlexTranAmz deleted the pin-gitPython branch August 25, 2026 21:56
Comment thread requirements-release.txt
@@ -1 +1,2 @@
python-semantic-release == 10.6.* No newline at end of file
python-semantic-release == 10.6.*
GitPython == 3.1.59 No newline at end of file

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants