aboutsummaryrefslogtreecommitdiff
path: root/scripts/vim-patch.sh
diff options
context:
space:
mode:
authorJongwook Choi <wookayin@gmail.com>2024-05-21 12:10:39 -0400
committerGitHub <noreply@github.com>2024-05-21 09:10:39 -0700
commit7aaa4a51b76fd136b5373acf8c5a0c7c278d8b5c (patch)
tree119779b3f4d5801863e474dbe5219da0faf22ab7 /scripts/vim-patch.sh
parent47c741e30c872cb1a535c7577684e0da4580992f (diff)
downloadrneovim-7aaa4a51b76fd136b5373acf8c5a0c7c278d8b5c.tar.gz
rneovim-7aaa4a51b76fd136b5373acf8c5a0c7c278d8b5c.tar.bz2
rneovim-7aaa4a51b76fd136b5373acf8c5a0c7c278d8b5c.zip
build(vim-patch.sh): include commit subject #28767
Problem: vim-patch commits lack an informative title and summary in the very first line of the commit message when the vim-revision is a Git SHA hash, unlike when is a Vim version. This makes it difficult to discern at a glance what changes are introduced by such vim-patch commits (in git log, PR title, changelog generated by git-cliff, etc.). BEFORE: vim-patch:abcdef123456 runtime(vim): improve performance <some details> ... Solution: Repeat the title of the upstream commit message, to improve the clarity and visibility of the commit message. AFTER: vim-patch:abcdef123456: runtime(vim): improve performance <some details> ... Note: the `vim-patch:<hash>` token is still needed by `vim-patch.sh` (but not necessarily in the very first line of the commit message) to determine which vim patches have been applied. `<hash>` is internally normalized to 7 hex digits.
Diffstat (limited to 'scripts/vim-patch.sh')
-rwxr-xr-xscripts/vim-patch.sh2
1 files changed, 1 insertions, 1 deletions
diff --git a/scripts/vim-patch.sh b/scripts/vim-patch.sh
index 45dd7f5fee..e8758c064f 100755
--- a/scripts/vim-patch.sh
+++ b/scripts/vim-patch.sh
@@ -122,7 +122,7 @@ commit_message() {
if [[ "${vim_message}" == "vim-patch:${vim_version}:"* ]]; then
printf '%s\n\n%s\n\n%s' "${vim_message}" "${vim_commit_url}" "${vim_coauthors}"
else
- printf 'vim-patch:%s\n\n%s\n\n%s\n\n%s' "$vim_version" "$vim_message" "$vim_commit_url" "$vim_coauthors"
+ printf 'vim-patch:%s: %s\n\n%s\n\n%s' "${vim_version:0:7}" "${vim_message}" "${vim_commit_url}" "${vim_coauthors}"
fi
}