@semantic-release/github

semantic-release 插件，用于发布 GitHub release 并在已发布的 Pull Requests/Issues 上添加评论。

安装

$ 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 releases 将会发布包含 dist/asset.min.css 和 dist/asset.min.js 文件的版本。

配置

GitHub 认证

GitHub 认证配置是必需的，可以通过环境变量设置。

请参照 创建用于命令行的个人访问令牌 文档获取认证令牌。该令牌必须通过 GH_TOKEN 环境变量在 CI 环境中可用。与令牌关联的用户必须对仓库具有推送权限。

创建令牌时，最低要求的作用域是：

• 私有仓库需要 repo
• 公共仓库需要 public_repo

关于 GitHub Actions 的注意事项： 你可以使用默认提供的 GITHUB_TOKEN 密钥。但是，使用此令牌进行的发布不会触发发布事件来启动其他工作流。 如果你有在新创建的发布上触发的操作，请为此生成一个令牌并将其存储在你的仓库的密钥中（任何除 GITHUB_TOKEN 之外的名称都可以）。

当使用 GITHUB_TOKEN 时，最低要求的权限是：

• contents: write 用于发布 GitHub release
• issues: write 用于在已发布的 issues 上添加评论
• pull-requests: write 用于在已发布的 pull requests 上添加评论

环境变量

选项

proxy

可以是 false、代理 URL 或具有以下属性的 Object：

有关更多详细信息，请参阅 node-https-proxy-agent 和 node-http-proxy-agent。

proxy 示例

'http://168.63.76.32:3128'：对每个 GitHub API 请求使用运行在主机 168.63.76.32 和端口 3128 上的代理。 {host: '168.63.76.32', port: 3128, headers: {Foo: 'bar'}}：对每个 GitHub API 请求使用运行在主机 168.63.76.32 和端口 3128 上的代理，将 Foo 头的值设置为 bar。

assets

可以是一个 glob 或 glob 和具有以下属性的 Object 的 Array：

assets Array 中的每个条目都会单独进行 glob 匹配。glob 可以是一个 String（"dist/**/*.js" 或 "dist/mylib.js"）或一个将一起进行 glob 匹配的 String 数组（["dist/**", "!**/*.css"]）。

如果配置了目录，将包含该目录及其子目录下的所有文件。

每个资产的 name 和 label 使用 Lodash 模板 生成。以下变量可用：

注意：如果一个文件在 assets 中有匹配项，即使它在 .gitignore 中也有匹配项，它也会被包含在内。

assets 示例

'dist/*.js'：包含 dist 目录中的所有 js 文件，但不包括其子目录中的文件。 [['dist', '!**/*.css']]：包含 dist 目录及其子目录中的所有文件，但不包括 css 文件。

[{path: 'dist/MyLibrary.js', label: 'MyLibrary JS distribution'}, {path: 'dist/MyLibrary.css', label: 'MyLibrary CSS distribution'}]：包含 dist/MyLibrary.js 和 dist/MyLibrary.css 文件，并在 GitHub 发布中分别标记为 MyLibrary JS distribution 和 MyLibrary CSS distribution。

[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}]：包含 dist 目录及其子目录中所有的 js 和 css 文件，但不包括压缩版本，同时包含 build/MyLibrary.zip 文件，并在 GitHub 发布中标记为 MyLibrary。

[{path: 'dist/MyLibrary.js', name: 'MyLibrary-${nextRelease.gitTag}.js', label: 'MyLibrary JS (${nextRelease.gitTag}) distribution'}]：包含 dist/MyLibrary.js 文件，并将其上传到 GitHub 发布中，命名为 MyLibrary-v1.0.0.js，标签为 MyLibrary JS (v1.0.0) distribution，这将生成以下链接：

[MyLibrary JS (v1.0.0) distribution](https://github.com/semantic-release/github/blob/master/MyLibrary-v1.0.0.js

successComment

问题评论的消息使用 Lodash 模板 生成。可用以下变量：

successComment 示例

successComment This ${issue.pull_request ? 'pull request' : 'issue'} is included in version ${nextRelease.version} 将生成以下评论：

This pull request is included in version 1.0.0

failComment

问题内容的消息使用 Lodash 模板 生成。可用以下变量：

failComment 示例

failComment This release from branch ${branch.name} had failed due to the following errors:\n- ${errors.map(err => err.message).join('\\n- ')} 将生成以下评论：

This release from branch master had failed due to the following errors:

• Error message 1
• Error message 2

releasedLabels

每个标签名称使用 Lodash 模板 生成。可用以下变量：

releasedLabels 示例

releasedLabels ['released<%= nextRelease.channel ? ` on @\${nextRelease.channel}` : "" %> from <%= branch.name %>'] 将生成以下标签：

released on @next from branch next

addReleases

将其他发布的链接添加到 GitHub 发布正文中。

此选项的有效值为 false、"top" 或 "bottom"。

addReleases 示例

有关其外观的示例，请参阅介绍性 PR。