如何在gh-pages的NPM部署脚本中添加原始Commit Hash到提交消息
解决跨平台gh-pages提交消息包含Git Commit Hash的问题
问题分析
你遇到的核心问题是Windows默认使用cmd执行NPM脚本,而cmd不支持Bash风格的命令替换($(...))和变量语法,导致之前的脚本在Windows下无法正确解析Git Commit Hash:
- 第一个脚本:
cmd不会解析$(git rev-parse HEAD),直接将其作为字面量提交 - 第二个脚本:
cmd把空格当作参数分隔符,导致仅截取$(git作为消息内容 - 第三个脚本:
cmd不支持var=value && command的Bash变量赋值语法,因此抛出**'git_commit' 未被识别为内部或外部命令、可执行程序或批处理文件**的错误
无额外依赖的跨平台解决方案
利用项目已有的Node.js环境(Svelte/TS项目必然包含),通过Node.js脚本获取Git Commit Hash,再传递给gh-pages命令。将deploy脚本修改为:
"deploy": "gh-pages --dist build --dotfiles --message \"$(node -e \"console.log('Deploying commit ' + require('child_process').execSync('git rev-parse HEAD').toString().trim())\")\""
如果想要更简洁的短Hash(默认7位),可以把git rev-parse HEAD改成git rev-parse --short HEAD:
"deploy": "gh-pages --dist build --dotfiles --message \"$(node -e \"console.log('Deploying commit ' + require('child_process').execSync('git rev-parse --short HEAD').toString().trim())\")\""
原理说明
node -e "<script>":通过Node.js执行单行脚本,天然跨平台兼容Windows和Linuxrequire('child_process').execSync('git rev-parse HEAD'):同步执行Git命令获取当前Commit的完整Hash,--short参数可生成短HashtoString().trim():将Git命令的Buffer输出转为字符串并去除首尾换行符- 最终生成的提交消息格式为
Deploying commit a1b2c3d(或完整Hash),跨平台一致生效
内容的提问来源于stack exchange,提问作者Kauê Rodrigues
相关产品推荐
相关产品推荐

