什么是 githook-deploy？
githook-deploy 是一个 npm 包，它可以自动化地在你的代码仓库中部署你的应用程序。它通过将 Git 钩子（Git hooks）绑定到你的代码仓库上，来自动化你的部署过程。当你向你的代码仓库推送新的代码时，githook-deploy 可以让你的应用程序自动部署到目标服务器上。
如何使用 githook-deploy？
步骤一：安装 githook-deploy
在你的项目根目录下，使用以下命令来安装 githook-deploy：
npm install githook-deploy --save-dev
步骤二：配置 githook-deploy
在你的项目根目录下，创建一个名为 .githookrc.json 的文件。这个文件用来配置 githook-deploy 的部署方式。以下是一个例子：
-- -------------------- ---- -------
-
--------- -
------- ------- --------
------ -----------------
------ -
--------- ---------
--------- ---------
------------- ------
------------------ -----
--
------- -
------- ---------------
----------- -------------
----------- -------------
------- --
-
-
-type: 用来指定部署方式，可以选择"git"或"sftp"或它们的组合。dir: 用来指定部署目录。git: 用来指定 Git 的参数。sftp: 用来指定 SFTP 的参数。
步骤三：配置 Git 钩子
在你的项目根目录下，打开 .git/hooks 目录。在这个目录下，你会发现一系列的文件，这些文件是 Git 钩子。你需要创建一个名为 post-receive 的文件，并将以下代码复制到这个文件中：
#!/bin/bash PATH="$PATH:/usr/local/bin" cd $GIT_WORK_TREE githook-deploy
记得要将 githook-deploy 这个命令替换为你项目中 githook-deploy 所在的路径。
步骤四：测试
现在你已经完成了所有的配置。可以尝试向你的代码仓库推送一些新的代码，然后查看你的应用程序是否已经自动部署到目标服务器上了。
深入 githook-deploy
git 部署方式
当你在配置文件中选择了 git 部署方式时，githook-deploy 会拉取最新的代码，并将代码部署到指定的目录下。下面是 git 部署方式可选的配置参数：
remote: 指定 Git 远程主机名，缺省值是"origin"。branch: 指定 Git 分支名，缺省值是"master"。pullBefore: 指定是否在部署之前拉取最新的代码，缺省值是false。submoduleUpdate: 指定是否在部署前更新子模块，缺省值是false。
sftp 部署方式
当你在配置文件中选择了 sftp 部署方式时，githook-deploy 会将你的代码上传到目标服务器上。下面是 sftp 部署方式可选的配置参数：
host: SFTP 服务器主机名或 IP。username: SFTP 登录用户名。password: SFTP 登录密码。port: SFTP 端口号，缺省值是22。
示例代码
以下是一个示例代码，展示了如何在一个 node.js 项目中使用 githook-deploy：
// 引入 githook-deploy 包
var githookDeploy = require('githook-deploy');
// 读取配置文件
var config = require('./.githookrc.json');
// 部署代码
githookDeploy(config.deploy);总结
使用 githook-deploy 可以帮助你自动化你的部署过程，提高开发效率。在使用过程中，需要注意配置文件的编写，以及 Git 钩子的设置。
希望这篇文章可以帮助你更好地了解 githook-deploy，并顺利地完成项目的部署。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600567bd81e8991b448e401b