如何快速安装与使用WIP GitHub App：完整指南

【免费下载链接】app The WIP GitHub App 项目地址: https://gitcode.com/gh_mirrors/app9/app

WIP GitHub App（The WIP GitHub App）是一款强大的开源工具，能够自动检测拉取请求标题中的关键词（如"wip"、"work in progress"或""），并将其状态设置为"pending"，有效防止未完成的代码被意外合并。本文将详细介绍这款实用工具的安装步骤和使用方法，帮助开发者提升协作效率。

核心功能与优势

WIP GitHub App通过智能检测机制，为开发团队提供以下核心功能：

• 自动状态管理：默认检测拉取请求标题中的特定关键词，自动将状态设为"pending"
• 灵活配置选项：Pro计划用户可自定义检测位置（标题、标签、提交信息）和关键词
• 无缝集成：与GitHub工作流完美融合，无需离开熟悉的开发环境

WIP GitHub App自动检测拉取请求状态并标记为"pending"的演示效果

简单三步安装指南

1. 克隆项目仓库

首先，将项目代码克隆到本地环境：

git clone https://gitcode.com/gh_mirrors/app9/app
cd app

2. 安装依赖包

使用npm安装项目所需的依赖：

npm install

项目主要依赖包括Probot文件。

3. 启动应用

安装完成后，通过以下命令启动应用：

npm start

基础使用方法

WIP GitHub App的基础功能开箱即用，无需额外配置：

1. 创建拉取请求时，在标题中包含以下任意关键词：

   • wip
   • work in progress
   • （施工中表情符号）

2. 应用会自动检测到这些关键词，并将拉取请求状态设置为"pending"

3. 当开发完成后，只需从标题中移除这些关键词，状态会自动更新

高级配置（Pro计划）

Pro计划用户可以通过创建.github/wip.yml文件来自定义检测规则。配置文件支持以下选项：

自定义检测位置

locations:
  - title          # 检测拉取请求标题
  - label_name     # 检测标签名称
  - commit_subject # 检测提交信息主题

自定义关键词

terms:
  - do not merge   # 自定义关键词1
  - ⛔             # 自定义表情符号

完整的配置示例和语法说明可参考项目README.md文件中的"Configuration"章节。

常见问题解答

如何覆盖"pending"状态？

在拉取请求正文中添加@wip ready for review，即可手动覆盖自动设置的"pending"状态。

如何查看应用日志？

WIP GitHub App部署在Vercel平台，日志会自动发送到Logflare。你可以通过访问项目统计页面public/stats/index.html查看基本运行状态。

非付费用户能否使用Pro功能？

如果无法付费但确实需要Pro功能，可以通过修改pro-plan-for-free.js文件申请免费使用Pro计划。

项目结构概览

app/
├── api/               # API处理逻辑
├── assets/            # 静态资源
├── lib/               # 核心功能模块
│   ├── common/        # 通用工具函数
│   ├── free/          # 免费版功能
│   └── pro/           # Pro版功能
├── public/            # 公共资源
└── test/              # 测试文件

核心功能实现可查看这些文件：

• 状态检测逻辑：lib/free/get-status.js
• 配置处理：lib/pro/get-config.js
• 主应用入口：index.js

总结

WIP GitHub App是一款简单而强大的工具，能够有效防止未完成代码被意外合并，提升团队协作效率。通过本文介绍的步骤，你可以快速安装并开始使用这款工具。无论是小型团队还是大型企业，WIP都能为你的GitHub工作流增添一份保障。

如需了解更多项目细节，请参考以下资源：

• 使用条款
• 贡献指南
• 行为准则
• 工作原理说明

【免费下载链接】app The WIP GitHub App 项目地址: https://gitcode.com/gh_mirrors/app9/app