Add trailer support for commit creation by Krishnachaitanyakc · Pull Request #2116 · gitpython-developers/GitPython

Krishnachaitanyakc · 2026-03-25T02:36:46Z

Summary

Adds a trailers parameter to Commit.create_from_tree() and IndexFile.commit() enabling trailer creation (e.g. Signed-off-by, Issue) when committing programmatically
Accepts either a dict or a list of (key, value) tuples (for duplicate keys like multiple Signed-off-by)
Uses git interpret-trailers for formatting, consistent with existing trailer parsing in Commit.trailers_list

Closes #1998

Motivation

GitPython already supports parsing trailers from existing commits, but did not support adding them when creating new commits. The git commit CLI supports this via --trailer, e.g.:

git commit --message "Did a thing" --trailer "Issue: abc"

This change brings equivalent functionality to GitPython's Python API.

Usage

# Using a dict
repo.index.commit("Fix bug", trailers={"Issue": "123"})

# Using a list of tuples (for duplicate keys)
repo.index.commit("Fix bug", trailers=[
    ("Signed-off-by", "Alice <alice@example.com>"),
    ("Signed-off-by", "Bob <bob@example.com>"),
])

# Via Commit.create_from_tree directly
Commit.create_from_tree(repo, tree, "Fix bug", trailers={"Reviewed-by": "Eve"})

Test plan

test_create_from_tree_with_trailers_dict - verifies dict-based trailer creation and round-trip parsing
test_create_from_tree_with_trailers_list - verifies list-of-tuples trailer creation with duplicate keys
test_index_commit_with_trailers - verifies IndexFile.commit() passes trailers through correctly
All 3 new tests pass locally

Add a `trailers` parameter to `Commit.create_from_tree()` and `IndexFile.commit()` that allows appending trailer key-value pairs (e.g. Signed-off-by, Issue) to the commit message at creation time. Trailers can be passed as either a dict or a list of (key, value) tuples, the latter being useful when duplicate keys are needed. The implementation uses `git interpret-trailers` for proper formatting, consistent with the existing trailer parsing in `Commit.trailers_list`. Closes gitpython-developers#1998

Byron · 2026-03-25T12:01:34Z

@codex review

Copilot

Pull request overview

Adds support for creating commit trailers when programmatically generating commits, aligning commit creation with GitPython’s existing trailer parsing capabilities.

Changes:

Add a trailers parameter to Commit.create_from_tree() to append trailers via git interpret-trailers.
Thread trailers through IndexFile.commit() so index commits can include trailers.
Add tests covering dict-based trailers, list-of-tuples trailers (duplicate keys), and the index commit plumbing.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
`git/objects/commit.py`	Adds `trailers` support in `Commit.create_from_tree()` by invoking `git interpret-trailers`.
`git/index/base.py`	Exposes `trailers` in `IndexFile.commit()` and forwards it to `Commit.create_from_tree()`.
`test/test_commit.py`	Adds round-trip tests validating trailer creation and parsing for both APIs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

git/objects/commit.py

Byron

Thanks a lot, this looks good to me.

The Copilot comments should be addressed and then it can be merged.

Krishnachaitanyakc · 2026-04-06T01:06:57Z

@Byron addressed those comments, can you please review?

Byron · 2026-04-06T08:12:00Z

It doesn't look like they are resolved, nor was anything pushed. Please also resolve them. Thank you.

Krishnachaitanyakc · 2026-04-06T16:13:57Z

@Byron sorry, missed pushing them. Can you review now?

Byron

Thanks a lot, looks good to me!

It's a shame that it's shelling out to build a string, but better to have a slow but correct version, than nothing at all in that regard.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-12T22:41:10Z

git/objects/commit.py

+            stdout_bytes, _ = proc.communicate(str(message).encode())
+            finalize_process(proc)
+            message = stdout_bytes.decode("utf8")


interpret-trailers I/O is hard-coded to UTF-8 (.encode() default + .decode('utf8')), but this method already resolves conf_encoding for the commit’s declared encoding. If i18n.commitencoding is not UTF-8, this can raise decode errors or corrupt non-ASCII characters; use the resolved encoding for both encoding stdin and decoding stdout (and consider an explicit error strategy).

Suggested change

stdout_bytes, _ = proc.communicate(str(message).encode())

finalize_process(proc)

message = stdout_bytes.decode("utf8")

stdout_bytes, _ = proc.communicate(str(message).encode(conf_encoding, errors="strict"))

finalize_process(proc)

message = stdout_bytes.decode(conf_encoding, errors="strict")

Copilot · 2026-04-12T22:41:10Z

git/objects/commit.py

+            )
+            stdout_bytes, _ = proc.communicate(str(message).encode())
+            finalize_process(proc)


This uses as_process=True, which makes Git.execute(..., with_exceptions=True) ineffective (see Git.execute docs), but the code never checks proc.returncode / stderr after communicate(). If interpret-trailers fails (e.g., unsupported --trailer on an older Git), message may be replaced with empty/partial stdout and the commit is still created; please detect non-zero exit status and raise (or preserve the original message on failure).

Suggested change

)

stdout_bytes, _ = proc.communicate(str(message).encode())

finalize_process(proc)

stderr=PIPE,

)

stdout_bytes, stderr_bytes = proc.communicate(str(message).encode())

finalize_process(proc)

if proc.returncode:

stderr = stderr_bytes.decode("utf8", errors="replace") if stderr_bytes else ""

raise RuntimeError(

"git interpret-trailers failed with exit code "

f"{proc.returncode}: {stderr or 'no error output'}"

)

Copilot · 2026-04-12T22:41:10Z

git/objects/commit.py

+            cmd = [repo.git.GIT_PYTHON_GIT_EXECUTABLE, "interpret-trailers"] + trailer_args
+            proc: Git.AutoInterrupt = repo.git.execute(  # type: ignore[call-overload]
+                cmd,


The command uses repo.git.GIT_PYTHON_GIT_EXECUTABLE here, but Commit.trailers_list/trailers_dict currently invoke interpret-trailers via a hard-coded ['git', ...]. If a caller overrides GIT_PYTHON_GIT_EXECUTABLE, trailer creation and trailer parsing can end up using different Git binaries; consider aligning both paths on the same executable selection approach for consistent round-trips.

Suggested change

cmd = [repo.git.GIT_PYTHON_GIT_EXECUTABLE, "interpret-trailers"] + trailer_args

proc: Git.AutoInterrupt = repo.git.execute( # type: ignore[call-overload]

cmd,

proc: Git.AutoInterrupt = repo.git._call_process( # type: ignore[attr-defined]

"interpret-trailers",

*trailer_args,

Byron requested a review from Copilot March 25, 2026 12:01

Copilot started reviewing on behalf of Byron March 25, 2026 12:01 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

git/objects/commit.py Outdated Show resolved Hide resolved

git/objects/commit.py Outdated Show resolved Hide resolved

Byron approved these changes Mar 25, 2026

View reviewed changes

Use configured git executable and finalize process for trailer creation

af0933c

Krishnachaitanyakc force-pushed the add-trailer-support-for-commit-creation branch from 4da170c to af0933c Compare April 6, 2026 15:59

Byron requested a review from Copilot April 12, 2026 22:36

Copilot started reviewing on behalf of Byron April 12, 2026 22:37 View session

Byron approved these changes Apr 12, 2026

View reviewed changes

Byron merged commit b5b87dd into gitpython-developers:main Apr 12, 2026
34 checks passed

Copilot AI reviewed Apr 12, 2026

View reviewed changes

Copilot AI mentioned this pull request Apr 12, 2026

Harden commit trailer subprocess handling and align trailer I/O paths #2125

Draft

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add trailer support for commit creation#2116

Add trailer support for commit creation#2116
Byron merged 2 commits intogitpython-developers:mainfrom
Krishnachaitanyakc:add-trailer-support-for-commit-creation

Krishnachaitanyakc commented Mar 25, 2026

Uh oh!

Byron commented Mar 25, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Byron left a comment

Uh oh!

Krishnachaitanyakc commented Apr 6, 2026

Uh oh!

Byron commented Apr 6, 2026

Uh oh!

Krishnachaitanyakc commented Apr 6, 2026

Uh oh!

Byron left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 12, 2026

Uh oh!

Copilot AI Apr 12, 2026

Uh oh!

Copilot AI Apr 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

-            )
-            stdout_bytes, _ = proc.communicate(str(message).encode())
-            finalize_process(proc)
+                stderr=PIPE,
+            )
+            stdout_bytes, stderr_bytes = proc.communicate(str(message).encode())
+            finalize_process(proc)
+            if proc.returncode:
+                stderr = stderr_bytes.decode("utf8", errors="replace") if stderr_bytes else ""
+                raise RuntimeError(
+                    "git interpret-trailers failed with exit code "
+                    f"{proc.returncode}: {stderr or 'no error output'}"
+                )

-            cmd = [repo.git.GIT_PYTHON_GIT_EXECUTABLE, "interpret-trailers"] + trailer_args
-            proc: Git.AutoInterrupt = repo.git.execute(  # type: ignore[call-overload]
-                cmd,
+            proc: Git.AutoInterrupt = repo.git._call_process(  # type: ignore[attr-defined]
+                "interpret-trailers",
+                *trailer_args,

Uh oh!

Conversation

Krishnachaitanyakc commented Mar 25, 2026

Summary

Motivation

Usage

Test plan

Uh oh!

Byron commented Mar 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Byron left a comment

Choose a reason for hiding this comment

Uh oh!

Krishnachaitanyakc commented Apr 6, 2026

Uh oh!

Byron commented Apr 6, 2026

Uh oh!

Krishnachaitanyakc commented Apr 6, 2026

Uh oh!

Byron left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants