plumbing: support commits extra headers, support jujutsu signed commit #1627
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
Would this be accepted in a backport to |
da8a130 to
4609194
Compare
Contributor
Author
|
@pjbgf any chance to get a review here? (Could I ask you'd click the button to run the CI for me? CI runs are restricted for first time contributors) |
691fde8 to
1bc63b7
Compare
Contributor
Author
pjbgf
requested changes
Sep 7, 2025
Comment on lines
348
to
415
| for _, header := range c.ExtraHeaders { | ||
| if _, err = fmt.Fprintf(w, "\n%s", header); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
Member
There was a problem hiding this comment.
Please add some validation around this logic. I'm not completely sure of all the validation that takes place upstream, but it would be good to explore adding checks for:
- Empty values
- Headers with the same name as core headers (
tree,author,committer,parent, etc.) - Header names without values
- Header values without names
Whatever we can confirm upstream blocks, we should also block.
Contributor
Author
There was a problem hiding this comment.
Does this version works for you?
Member
I'm happy to support the backporting once this PR is merged. |
1bc63b7 to
6e1764b
Compare
This adds support for extra headers. While git has a set of ["standard headers"] (`tree`, `parent`, `author`, `committer`, and `encoding`), it will also support [extra headers] when serializing. The extra headers must come after the standard ones, but they are otherwise freetyped. [Jujutsu] takes advantage of that to store its own identifier (`change-id`) as an extra header. Because signatures will cover the hash of the whole commit (standard headers, extra headers and the message. Everything but the signature itself), if we deserialize a commit and then `EncodeWithoutSignature` to get back the "canonical" representation of a commit, if we don't serialize back the extra headers, the hash will no longer match and the signature will fail to verify. This adds support for parsing and reencoding the extra headers from the original commit and it's expected to fix support for Jujutsu signed commits. Fixes go-git#1626 ["standard headers"]: https://github.com/git/git/blob/724518f3884d8707c5f51428ba98c115818229b8/commit.c#L1450 [extra headers]: https://github.com/git/git/blob/724518f3884d8707c5f51428ba98c115818229b8/commit.c#L1690 [Jujutsu]: https://github.com/jj-vcs/jj
6e1764b to
eb42b9a
Compare
Contributor
Author
|
@pjbgf any chance to get another review here? This bug has been a problem in my everyday workflow and I'd love to get it fixed. Thanks a lot! |
tstenner
pushed a commit
to tstenner/go-git
that referenced
this pull request
Sep 17, 2025
plumbing: support commits extra headers, support jujutsu signed commit
Contributor
Author
|
Deployed this morning. Works as expected, thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds support for extra headers. While git has a set of "standard headers" (
tree,parent,author,committer, andencoding), it will also support extra headers when serializing.The extra headers must come after the standard ones, but they are otherwise freetyped.
Jujutsu takes advantage of that to store its own identifier (
change-id) as an extra header.Because signatures will cover the hash of the whole commit (standard headers, extra headers and the message. Everything but the signature itself), if we deserialize a commit and then
EncodeWithoutSignatureto get back the "canonical" representation of a commit, if we don't serialize back the extra headers, the hash will no longer match and the signature will fail to verify.This adds support for parsing and reencoding the extra headers from the original commit and it's expected to fix support for Jujutsu signed commits.
Fixes #1626