使用release-it实现NPM发布与GitHub Release自动化

release-it是一个强大的版本管理和发布工具，它能够自动化执行版本更新、生成变更日志、创建GitHub Release以及发布到NPM等操作。本文将详细介绍如何正确配置release-it来实现这些功能。

常见配置问题分析

在实际使用中，开发者经常会遇到配置正确但功能未按预期执行的情况。这通常是由于配置文件命名错误或路径问题导致的。release-it默认会查找以下配置文件：

1. .release-it.json
2. .release-it.js
3. .release-it.yaml
4. .release-it.yml
5. package.json中的release-it配置节

推荐配置方案

对于需要同时发布到NPM和GitHub的项目，推荐使用以下配置结构：

{
  "git": {
    "commitMessage": "chore: release v${version}"
  },
  "github": {
    "release": true
  },
  "npm": {
    "publish": true
  },
  "plugins": {
    "@release-it/conventional-changelog": {
      "infile": "CHANGELOG.md",
      "preset": {
        "name": "conventionalcommits",
        "types": [
          {
            "type": "feat",
            "section": "Features"
          },
          {
            "type": "fix",
            "section": "Bug Fixes"
          }
        ]
      }
    }
  }
}

GitHub Actions集成最佳实践

在GitHub Actions中集成release-it时，需要注意以下几个关键点：

1. 确保设置了正确的Git用户信息
2. 提供必要的token权限
3. 处理pnpm/npm缓存优化构建速度

steps:
  - name: Set Git Credentials
    run: |
      git config user.name "${GITHUB_ACTOR}"
      git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
      
  - name: Release It
    run: pnpm run release
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

故障排查指南

当遇到release-it未按预期工作时，可以按照以下步骤排查：

1. 检查配置文件名称和路径是否正确
2. 确认所有必要的token都已正确设置
3. 查看CI日志中的详细输出
4. 尝试在本地运行release-it的dry-run模式
5. 确保package.json中的版本号格式正确

版本管理策略建议

结合conventional-changelog插件，推荐采用以下commit规范：

• feat: 新功能
• fix: bug修复
• docs: 文档更新
• style: 代码样式调整
• refactor: 代码重构
• test: 测试相关
• chore: 构建过程或辅助工具变更

这种规范化的commit信息能够自动生成结构良好的CHANGELOG.md文件，并帮助工具正确识别版本变更类型(主版本/次版本/修订号)。

通过正确配置和使用release-it，开发者可以大幅简化版本管理和发布流程，确保NPM发布和GitHub Release创建的自动化与可靠性。