Google Release Please Action 中自定义提交前缀与配置文件失效问题解析

Google Release Please Action 是一个流行的自动化版本发布工具，它能够根据提交信息自动生成变更日志并创建发布PR。然而在v4版本中，许多开发者遇到了自定义提交前缀和配置文件设置失效的问题。

问题现象

开发者在使用v4版本时发现，即使按照文档配置了release-please-config.json文件，自定义的提交前缀（如"chore"、"ci"等）无法触发版本更新，同时指定的额外文件（如README）也不会被自动更新。系统日志中会出现"未发现用户可见提交"的提示，导致无法生成预期的发布PR。

问题根源

经过开发者社区的反复测试和验证，发现问题的关键在于v4版本中配置文件的加载逻辑发生了变化。当在GitHub Action工作流文件中同时指定了release-type参数和配置文件时，配置文件中的部分设置会被覆盖或忽略。

解决方案

正确配置方法

1. 简化工作流文件：在工作流文件中仅保留必要的参数（如token），移除release-type等可能冲突的配置项。

steps:
  - uses: google-github-actions/release-please-action@v4
    with:
      token: ${{ secrets.RELEASE_TOKEN }}

2. 完整配置文件：将所有配置移至release-please-config.json文件中，包括发布类型、变更日志分段等设置。

{
  "packages": {
    ".": {
      "release-type": "python",
      "changelog-sections": [
        {"type": "feat", "section": "Features"},
        {"type": "fix", "section": "Bug Fixes"},
        {"type": "chore", "section": "Miscellaneous"}
      ]
    }
  }
}

针对不同技术栈的配置示例

Node.js项目配置

{
  "packages": {
    ".": {
      "release-type": "node",
      "changelog-sections": [
        {"type": "feat", "section": "新功能"},
        {"type": "fix", "section": "问题修复"},
        {"type": "chore", "section": "维护任务"}
      ]
    }
  }
}

Python项目配置

{
  "packages": {
    ".": {
      "release-type": "python",
      "extra-files": ["README.md"],
      "changelog-sections": [
        {"type": "feat", "section": "新增功能"},
        {"type": "docs", "section": "文档更新"}
      ]
    }
  }
}

最佳实践建议

1. 单一配置源原则：尽量将所有配置集中在配置文件中，避免在工作流文件中重复设置。

2. 版本控制：将.release-please-manifest.json文件纳入版本控制，作为初始版本声明。

3. 测试验证：在正式使用前，可以通过测试分支验证配置是否按预期工作。

4. 变更日志分段：合理规划变更日志的分段结构，使发布说明更加清晰易读。

5. 团队规范：确保团队成员使用统一的提交信息前缀，以便工具正确识别和分类变更。

通过遵循这些实践方法，开发者可以充分利用Google Release Please Action的自动化能力，同时保持对发布流程的灵活控制。