Skip to content

Ensure proper footer sorting of footer #256

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
merged 1 commit into from
Mar 12, 2025
Merged

Ensure proper footer sorting of footer #256

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
24 changes: 21 additions & 3 deletions scripts/commit-msg.hook
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,16 @@ get_all_match_positions() {
done <<< "$targets"
}

KNOWN_TRAILERS_BY=(
'Signed-off-by'
'Reviewed-by'
'Co-authored-by'
'Acked-by'
'Suggested-by'
'Tested-by'
'Reported-by'
)

# Build regex for detecting commit trailers.
build_commit_trailer_regex() {
local -a keys specials standalones trailers
Expand All @@ -145,12 +155,17 @@ build_commit_trailer_regex() {
'Signed-off-by' 'Suggested-by' 'Tested-by'
)

trailers_test=(
'CC' 'Change-Id' 'Closes'
"${KNOWN_TRAILERS_BY[@]}"
)
# Standalone keys (those that do not require a value).
standalones=(
'(Doc|Upgrade|Security)Impact'
"Git-Dch[$separators] (Ignore|Short|Full)"
)


# Read custom trailer keys from git config and add them either to specials or trailers.
# This loop reads lines matching 'trailer.*.key'.
while read -r _ key; do
Expand All @@ -170,6 +185,10 @@ build_commit_trailer_regex() {
fi
done < <(git config --get-regexp 'trailer.*.key')

if [[ ${#trailers_by[@]} -eq 0 ]]; then
trailers_by=("${DEFAULT_TRAILERS_BY[@]}")
fi

# Possible trailers :
# - Acked-by
# - Co-authored-by
Expand All @@ -178,8 +197,7 @@ build_commit_trailer_regex() {
# - Signed-off-by
# - Suggested-by
# - Tested-by
TRAILERS_BY_REGEX="^($(IFS='|'; echo "${trailers_by[*]}")):"

TRAILERS_BY_REGEX="/($(IFS='|'; echo "${trailers_by[*]}" | tr '[:upper:]' '[:lower:]'))/"
# Begin constructing the regex.
TRAILER_REGEX='^('

Expand Down Expand Up @@ -610,7 +628,7 @@ add_change_id() {
other_footer = ""

for (line = 1; line <= numlines; line++) {
if (match(tolower(footer[line]), TRAILERS_BY_REGEX)) {
if (match(tolower(footer[line]), '"$TRAILERS_BY_REGEX"')) {
trailers = trailers footer[line] "\n"
} else {
other_footer = other_footer footer[line] "\n"
Expand Down
Loading