erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 00:15:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

maint(resources): honor configure comment character in commit message

Browse source 
Git allows to specify a comment character different from the default
`#`. This is helpful when using markdown in commit messages, especially
when adding a user test section that has to start with `# User testing`
in order for the test bot to detect it.

This change modifies the `prepare-commit-msg` hook and adds a check for
a configured `core.commentString` or `core.commentChar`. If both are not
set it falls back to the default `#` character.

You can set a different comment character with
`git config core.commentChar //`.

Build-bot: skip
Test-bot: skip
This commit is contained in:
Eberhard Beilharz 2025-09-05 10:45:58 +02:00
parent 8e65d13559
commit 1becb87547
No known key found for this signature in database
GPG key ID: E9140597606020D3
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
resources/git-hooks/prepare-commit-msg
View file

@ -114,18 +114,25 @@ function prepend_scope() {
fi
fi
commentchar="#"
if [[ -n "$(git config core.commentString)" ]]; then
commentchar="$(git config core.commentString)"
elif [[ -n "$(git config core.commentChar)" ]]; then
commentchar="$(git config core.commentChar)"
fi
postfix=$(
cat <<EOF
\n# Keyman Conventional Commit suggestions:
#
# - Link to a Sentry issue with git trailer:
# Fixes: _MODULE_-_ID_
# - Give credit to co-authors:
# Co-authored-by: _Name_ <_email_>
# - Use imperative, present tense ('attach' not 'attaches', 'attached' etc)
# - Don't include a period at the end of the title
# - Always include a blank line before trailers
# - More: https://github.com/keymanapp/keyman/wiki/Pull-Request-and-Commit-workflow-notes
\n${commentchar} Keyman Conventional Commit suggestions:
${commentchar}
${commentchar} - Link to a Sentry issue with git trailer:
${commentchar} Fixes: _MODULE_-_ID_
${commentchar} - Give credit to co-authors:
${commentchar} Co-authored-by: _Name_ <_email_>
${commentchar} - Use imperative, present tense ('attach' not 'attaches', 'attached' etc)
${commentchar} - Don't include a period at the end of the title
${commentchar} - Always include a blank line before trailers
${commentchar} - More: https://github.com/keymanapp/keyman/wiki/Pull-Request-and-Commit-workflow-notes
EOF
)
@ -170,4 +177,4 @@ case $COMMIT_SOURCE in
# Known possibilities: message (-m), template (-t)
exit 0
;;
esac
esac