kinzal/pr

kinzal/pr镜像说明

镜像概述

kinzal/pr镜像是一个用于自动化处理GitHub Pull Request（PR）的CLI工具，通过规则表达式实现对PR的批量操作，支持合并、标签管理、负责人分配等任务，适用于CI/CD流程或批量PR管理场景。

核心功能

1. PR合并：根据规则自动合并符合条件的PR。
2. PR审核：对符合规则的PR添加审核意见（如批准）。
3. 标签管理：批量添加、删除或替换PR标签。
4. 负责人分配：批量添加、删除或替换PR负责人。
5. 规则检查：验证PR是否符合预设规则，并可触发条件操作（如合并）。
6. PR查询：显示符合规则的PR列表。
7. 规则验证：检查规则表达式的有效性及匹配情况。

使用场景

• CI/CD流程中自动合并通过所有检查的PR。
• 批量管理PR标签（如为待审核PR添加指定标签）。
• 验证PR是否满足团队预设的合并条件（如至少3个成功状态检查）。

配置说明

环境变量

• GITHUB_TOKEN：GitHub个人访问令牌（必填），用于授权操作PR。

规则表达式

使用JMESPath语法定义规则，支持扩展函数（如now()获取当前时间）和日期字符串转换（如"2006-01-02T15:04:05Z"转为Unix时间）。

部署示例

Docker Run示例

bash
# 查看帮助
docker run --rm kinzal/pr --help

# 合并符合规则的PR（替换<your_token>、[owner]、[repo]）
docker run --rm -e GITHUB_TOKEN=<your_token> kinzal/pr merge [owner]/[repo] --with-statuses -l 'state == `"open"`' -l 'length(statuses[?state == `"success"`]) > `3`'

# 为符合规则的PR添加标签
docker run --rm -e GITHUB_TOKEN=<your_token> kinzal/pr label [owner]/[repo] -l 'state == `"open"`' --action "append" --label "review-needed"

规则验证示例

bash
docker run --rm -e GITHUB_TOKEN=<your_token> kinzal/pr validate [owner]/[repo] --with-statuses -l 'state == `"open"`' -l 'length(statuses[?state == `"success"`]) > `0`'

许可证

该工具遵循MIT许可证，详情见https://github.com/k-kinzal/pr%E3%80%82 ===END===