Changesets Action 发布流程中的权限问题解析

Changesets Action 发布流程中的权限问题解析

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

问题背景

在使用 Changesets Action 进行 npm 包发布时，开发者可能会遇到发布失败但日志中没有明确错误信息的情况。典型的症状是日志中突然出现一大段 minified 的 JavaScript 代码，而没有显示实际的错误原因。

问题分析

这种看似"无错误"的失败通常与 GitHub Actions 的权限配置有关。Changesets Action 需要特定的权限才能完成其工作流程：

1. 创建 Pull Request：Changesets 需要创建发布 PR 的权限
2. 推送代码变更：需要将变更推送到仓库的权限
3. 发布到 npm：需要访问 npm 注册表的权限

解决方案

正确的权限配置

在 GitHub Actions 工作流文件中，必须显式声明以下权限：

permissions:
  id-token: write
  contents: write

关键点说明

1. contents: write：允许工作流向仓库推送变更和创建 PR
2. id-token: write：如果使用 GitHub 容器注册表(ghcr)等需要身份验证的服务时需要

完整的 Action 配置示例

- name: Create Release Pull Request or Publish to npm
  uses: changesets/action@v1
  with:
    publish: npm run ci  # 或自定义的发布命令
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

最佳实践建议

1. 自定义发布命令：可以在 package.json 中定义完整的发布流程脚本

   "scripts": {
     "ci": "npm run check-format && npm run build && npx changeset publish"
   }
   

2. 分步调试：如果遇到问题，可以先单独运行各步骤检查哪一步失败

3. 权限最小化：只授予工作流必要的权限，遵循安全最佳实践

总结

Changesets Action 的发布失败往往与权限配置不当有关。通过正确设置 GitHub Actions 的工作流权限，并确保发布命令配置正确，可以解决大多数发布问题。记住，GitHub Actions 的显式权限声明会覆盖仓库的默认设置，这是许多开发者容易忽略的关键点。

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