commitlint-bot 使用教程

commitlint-bot 使用教程

commitlint-bot [NOT MAINTAINED] use https://github.com/apps/semantic-pull-requests 项目地址: https://gitcode.com/gh_mirrors/co/commitlint-bot

1. 项目介绍

commitlint-bot 是一个基于 Probot 框架开发的 GitHub 应用，用于在新的或编辑的 Pull Request 中自动运行 commitlint 检查所有提交信息，并设置适当的状态检查。commitlint 是一个用于强制执行提交消息格式的工具，确保团队成员遵循一致的提交规范。

该项目的主要功能包括：

• 自动检查 Pull Request 中的提交消息格式。
• 在提交消息不符合规范时，提供详细的错误信息。
• 支持通过 GitHub 分支保护机制，强制要求提交消息通过 commitlint 检查。

2. 项目快速启动

2.1 安装依赖

首先，克隆项目到本地并安装依赖：

git clone https://github.com/z0al/commitlint-bot.git
cd commitlint-bot
npm install

2.2 创建 GitHub App

1. 访问 GitHub Apps 页面，创建一个新的 GitHub App。
2. 设置应用的权限，确保应用有权限访问仓库的提交信息。
3. 生成并下载私钥文件，将其保存为 private-key.pem。

2.3 配置环境变量

在项目根目录下创建一个 .env 文件，并添加以下内容：

APP_ID=你的GitHub应用ID
PRIVATE_KEY_PATH=./private-key.pem
WEBHOOK_SECRET=你的Webhook密钥

2.4 启动应用

使用以下命令启动应用：

npm start

2.5 配置 Webhook

将 GitHub App 的 Webhook URL 设置为你的本地服务器地址（例如使用 localtunnel）：

npx localtunnel --port 3000

将生成的 URL 配置到 GitHub App 的 Webhook URL 中。

3. 应用案例和最佳实践

3.1 应用案例

假设你在一个团队中工作，团队成员提交的代码经常不符合提交消息规范。通过使用 commitlint-bot，你可以自动检查每个 Pull Request 中的提交消息，确保所有提交都符合团队的规范。

3.2 最佳实践

• 分支保护：在仓库的设置中启用分支保护，并要求 commitlint 状态检查通过后才能合并 Pull Request。
• 自定义配置：虽然 commitlint-bot 目前不支持自定义配置文件（如 commitlint.yml），但你可以通过修改代码来实现自定义配置。

4. 典型生态项目

• Probot：commitlint-bot 是基于 Probot 框架开发的，Probot 是一个用于构建 GitHub Apps 的 Node.js 框架。
• commitlint：commitlint 是一个用于检查提交消息格式的工具，commitlint-bot 依赖于 commitlint 来执行提交消息检查。
• semantic-pull-requests：一个类似的 GitHub App，用于检查 Pull Request 标题是否符合语义化版本规范。

通过以上步骤，你可以快速启动并使用 commitlint-bot 来确保团队提交消息的一致性和规范性。

commitlint-bot [NOT MAINTAINED] use https://github.com/apps/semantic-pull-requests 项目地址: https://gitcode.com/gh_mirrors/co/commitlint-bot