推荐使用 @semantic-release/github 插件

推荐使用 @semantic-release/github 插件

项目介绍

@semantic-release/github 是一个强大的插件，专为 semantic-release 设计，用于发布 GitHub 发布 并在已发布的 Pull Requests/Issues 上添加评论。该插件通过自动化发布流程，极大地简化了版本管理和发布工作。

项目技术分析

@semantic-release/github 插件提供了多个关键步骤，包括 verifyConditions、publish、addChannel、success 和 fail，每个步骤都有明确的职责和功能：

• verifyConditions: 验证认证信息和资产选项配置的有效性。
• publish: 发布 GitHub 发布，并可选择上传文件资产。
• addChannel: 更新 GitHub 发布的 pre-release 字段。
• success: 在每个已解决的 GitHub Issue 或 Pull Request 上添加评论。
• fail: 在发布失败时打开或更新 GitHub Issue，提供错误信息。

项目及技术应用场景

该插件适用于需要自动化版本发布和管理的项目，特别是在以下场景中：

• 持续集成/持续部署 (CI/CD): 自动化发布流程，确保每次代码提交后都能自动发布新版本。
• 开源项目管理: 简化开源项目的版本管理和发布流程，提高社区参与度。
• 多环境部署: 在不同环境中自动发布和管理版本，确保一致性和可靠性。

项目特点

• 自动化: 自动处理发布流程，减少人工干预。
• 灵活配置: 通过配置文件灵活设置发布选项，如资产上传、评论内容等。
• 安全性: 通过环境变量配置 GitHub 认证信息，确保安全性。
• 集成性: 与 semantic-release 无缝集成，提供完整的版本管理解决方案。

安装与使用

$ npm install @semantic-release/github -D

在 semantic-release 配置文件中配置插件：

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    [
      "@semantic-release/github",
      {
        "assets": [
          { "path": "dist/asset.min.css", "label": "CSS distribution" },
          { "path": "dist/asset.min.js", "label": "JS distribution" }
        ]
      }
    ]
  ]
}

通过以上配置，GitHub 发布将包含 dist/asset.min.css 和 dist/asset.min.js 文件。

配置

GitHub 认证

GitHub 认证配置是必需的，可以通过环境变量设置。请参考 Creating a personal access token for the command line 文档获取认证令牌，并将其设置在 GH_TOKEN 环境变量中。

环境变量

| 变量 | 描述 | | ------------------------------ | ------------------------------------------------------------ | | GITHUB_TOKEN 或 GH_TOKEN | 必需。用于认证的令牌。 | | GITHUB_URL 或 GH_URL | GitHub 服务器端点。 | | GITHUB_PREFIX 或 GH_PREFIX | GitHub API 前缀，相对于 GITHUB_URL。 | | GITHUB_API_URL | GitHub API 端点。注意，这将覆盖 GITHUB_PREFIX。 |

选项

| 选项 | 描述 | 默认值 | | ------------------------ | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | githubUrl | GitHub 服务器端点。 | GH_URL 或 GITHUB_URL 环境变量。 | | githubApiPathPrefix | GitHub API 前缀，相对于 githubUrl。 | GH_PREFIX 或 GITHUB_PREFIX 环境变量。 | | githubApiUrl | GitHub API 端