Git Cliff在Monorepo中获取PR详情时遇到的404错误解析

在使用Git Cliff工具为Monorepo项目生成变更日志时，开发者可能会遇到404错误导致无法正确获取Pull Request信息的问题。本文将深入分析这一问题的成因及解决方案。

问题现象

当在Monorepo结构中使用Git Cliff时，工具会尝试通过GitHub API获取提交记录和关联的PR信息。但在某些情况下，API请求会返回404错误，具体表现为：

1. 获取提交列表时出现404错误
2. 获取PR列表时出现404错误
3. 日志中显示JSON解析错误，提示"invalid type: map, expected a sequence"

问题根源

经过分析，这个问题主要由以下两个因素导致：

1. GitHub API权限不足：当Git Cliff尝试访问私有仓库或受限资源时，如果提供的访问令牌(GitHub Token)没有足够的权限，API会返回404错误而非403，这容易造成误解。

2. Monorepo特殊结构：在Monorepo中，项目采用特殊的目录结构和标签命名方式（如<dir-name>/0.1.0），这需要Git Cliff进行特殊配置才能正确处理。

解决方案

1. 正确配置GitHub Token权限

确保使用的GitHub Token具有以下最小必要权限：

• contents: read - 读取仓库内容
• pull-requests: read - 读取PR信息

在GitHub Actions中的配置示例：

permissions:
  contents: read
  pull-requests: read

2. 针对Monorepo的特殊配置

对于Monorepo项目，需要在Git Cliff配置中明确指定：

• 包含的路径模式：--include-path "charts/<dir-name>/*"
• 标签匹配模式：--tag-pattern "<dir-name>/(.)"

完整命令示例：

git cliff -v --github-repo <org>/<repo> --include-path "charts/<dir-name>/*" --tag-pattern "<dir-name>/(.)" -x

3. 模板调整

在变更日志模板中，可以通过contributor对象访问PR信息。注意使用正确的属性名pr_number而非prnumber：

{% for contributor in github.contributors %}
  {% if contributor.pr_number %} 
  相关PR: [#{{ contributor.pr_number }}](PR链接)
  {%- endif %}
{%- endfor -%}

最佳实践建议

1. 始终在测试环境先验证GitHub Token的权限是否足够
2. 对于复杂项目结构，先使用-v参数启用详细日志以便调试
3. 考虑在CI/CD流水线中缓存API响应，减少对GitHub API的频繁调用
4. 对于大型Monorepo，可以分批处理不同子项目的变更日志生成

通过以上措施，开发者可以解决Git Cliff在Monorepo环境中获取PR信息时的404错误问题，确保变更日志生成的准确性和完整性。