Hubot 脚本库安装与使用教程

Hubot 脚本库安装与使用教程

hubot-scriptsDEPRECATED, see https://github.com/github/hubot-scripts/issues/1113 for details - optional scripts for hubot, opt in via hubot-scripts.json项目地址:https://gitcode.com/gh_mirrors/hu/hubot-scripts

1. 项目目录结构及介绍

Hubot 脚本库的目录结构如下：

.
├── CHANGELOG.md      // 更新日志
├── CONTRIBUTING.md   // 贡献指南
├── LICENSE           // 许可证文件
├── README.md         // 项目简介
├── package.json      // 项目依赖和元数据
└── src/
    └── scripts        // 脚本源代码目录，包含各种可用脚本

src/scripts 目录是核心部分，其中包含了各种社区贡献的 Hubot 脚本。

2. 项目启动文件介绍

Hubot 的启动文件通常不在 hubot-scripts 库中，而是位于你的自定义 Hubot 实例项目里。典型的启动文件是 bin/hubot 或者 start.sh（或类似的批处理文件），它们会调用 hubot 命令来启动机器人服务。在这些启动文件中，你可能看到类似以下的内容：

#!/usr/bin/env node
require('path').dirname(process.execPath)
process.chdir(__dirname)

var env = process.env.NODE_ENV || 'development'
var bin = require('../bin/hubot')
bin(env)

这段代码设置环境并执行 Hubot 的入口点，使其能够加载配置和所需脚本。

3. 项目配置文件介绍

external-scripts.json

这个文件位于你的自定义 Hubot 实例项目中，用于指定从 hubot-scripts 存储库或其他来源要加载的外部脚本。例如：

["redis-brain", "shipit", "hubot-github-pr"]

每个条目对应一个 Hubot 脚本，当你更新此文件添加新脚本时，Hubot 将加载并运行这些脚本。

package.json

同样在你的 Hubot 实例项目中，package.json 文件包含了项目依赖。你需要在这里添加任何依赖于特定版本的脚本，这样在启动 Hubot 时才能正确加载。比如：

{
  "dependencies": {
    "hubot": "^3.0.0",
    "hubot-scripts": "^2.16.7",
    "hubot-github-pr": "^1.2.3"
  }
}

确保更新 package.json 并运行 npm install 来安装新的或更新的依赖项。

环境变量

许多 Hubot 脚本需要特定的环境变量才能正确工作。这些变量应该在运行 Hubot 之前设置，通常是通过操作系统级别的环境变量或者在 env 文件中。例如，如果你的脚本需要连接到 Redis，你可能需要设置 HUBOT_REDIS_URL 变量。

请注意，hubot-scripts 不再包含所有外部依赖，因此确保在脚本的文档头中查看并设置所有必要的依赖和环境变量。

完成上述步骤后，重启你的 Hubot 机器人以应用新的配置和脚本。如有疑问，请查阅相关脚本的文档或 hubot 的官方文档。

hubot-scriptsDEPRECATED, see https://github.com/github/hubot-scripts/issues/1113 for details - optional scripts for hubot, opt in via hubot-scripts.json项目地址:https://gitcode.com/gh_mirrors/hu/hubot-scripts