Skip to content

Git Trailers Quick Reference ​

Parse trailers ​

git log -1 --format="%B" | git interpret-trailers --parse

# Conditional CI skip
skip=$(git log -1 --format="%(trailers:key=CI-Skip,valueonly)")
test "$skip" = "true" && exit 0

# Single-key extract
git log -1 --format="%(trailers:key=Reviewed-by,valueonly)"

# All format placeholders (Git 2.44+)
%(trailers:key=K,valueonly)     # just the value
%(trailers:key=K,separator=%n)  # multi-value newline separator
%(trailers:only)                 # entire trailer block

Add trailers at commit ​

git commit -m "msg" --trailer "Signed-off-by: A <a@b>"
git commit -m "msg" --trailer "Key: Val1" --trailer "Key: Val2"
git commit --amend --trailer "Reviewed-by: alice" --no-edit

Add trailers after commit ​

git interpret-trailers --in-place --trailer "Release-Phase: staging" HEAD
git interpret-trailers --in-place --trailer "Fixes: #42" HEAD

Config keys ​

[trailer "ChangeId"]
        key = Change-Id
        command = echo "I$(uuidgen | tr -d -)"

[trailer "Reviewed-by"]
        where = before
        ifexists = addIfDifferentNeighbor
ConfigValues
trailer.whereafter, before, end, start
trailer.ifexistsaddIfDifferent, addIfDifferentNeighbor, add, replace, doNothing
trailer.ifmissingadd, doNothing

DevOps one-liners ​

DCO pre-receive check:

author=$(git log -1 --format="%aN <%aE>")
sob=$(git log -1 --format="%(trailers:key=Signed-off-by,valueonly)" | head -1)
test "$author" != "$sob" && exit 1

Backport stamp:

git cherry-pick -x $SHA
git commit --amend --trailer "Backport-Source: $SHA" --no-edit

Changelog extract:

git log $FROM..$TO --format="%(trailers:key=Release-Notes,valueonly)" | grep -v '^$'

Pitfalls ​

  • Blank line before trailer block is required
  • %(trailers: ...) format needs Git 2.44+
  • --in-place only edits the working message file, not the SHA

Git Master — Git Reference for Every Skill Level