Changesets Action 版本更新PR自动关闭问题分析

Changesets Action 版本更新PR自动关闭问题分析

action 项目地址: https://gitcode.com/gh_mirrors/acti/action

问题现象

在使用changesets/action v1.5.2版本时，发现当存在未合并的"Version Packages" Pull Request时，如果向主分支(main)提交了新的变更文件(changefiles)，该action会自动关闭现有的版本更新PR，但不会创建新的PR。这显然不符合预期行为，因为开发者期望的是能够自动更新现有的PR而不是关闭它。

问题背景

Changesets是一个用于管理项目版本和变更日志的工具，它通过一个GitHub Action来自动化版本更新流程。当开发者提交变更描述文件(.changeset)后，该action会自动：

1. 收集所有变更
2. 更新版本号
3. 生成变更日志
4. 创建或更新"Version Packages" PR

技术分析

经过深入分析，发现问题与action的commit模式(github-api)有关。在这种模式下：

1. action需要重置分支以提交新的文件变更
2. 重置操作会隐式关闭现有的PR
3. 理论上，action应该在之后重新打开PR

但在v1.5.2版本中，重新打开PR的步骤未能正确执行。进一步测试发现：

• 在v1.5.0版本中能够正确重新打开现有PR
• 在v1.5.1版本中行为不稳定，有时能重新打开，有时会创建新PR
• 问题根源在于GitHub API的响应速度导致的竞态条件

根本原因

问题的本质在于action的工作流程存在时序问题：

1. 首先查询现有的PR列表
2. 然后推送变更(这会关闭PR)
3. 最后尝试更新PR状态

由于GitHub API的响应延迟，在第3步时，PR关闭的状态可能还未完全同步，导致action误认为没有现有PR存在(查询返回空数组[])，从而无法执行重新打开操作。

解决方案

修复方案相对简单：确保在推送任何变更之前就获取现有的PR列表。这样即使推送变更导致PR关闭，action仍然保有之前的PR信息，能够正确地重新打开它。

临时解决方案

对于遇到此问题的用户，可以采取以下临时措施：

1. 降级到v1.5.0版本
2. 手动重新打开被关闭的PR
3. 等待修复版本发布后升级

最佳实践建议

为了避免类似问题，建议：

1. 在CI/CD流程中增加对PR状态的检查
2. 考虑使用更稳定的commit模式
3. 对于关键发布流程，实施人工审核步骤

总结

这个问题展示了在自动化流程中处理GitHub PR状态时的常见陷阱。通过这次分析，我们不仅解决了具体问题，也为类似工具的开发者提供了处理PR状态同步问题的参考模式。理解GitHub API的响应特性和竞态条件的处理对于构建可靠的自动化工作流至关重要。

action 项目地址: https://gitcode.com/gh_mirrors/acti/action