gitlab下载 - gitlab源码下载

gitlab

其他源码

v13.2.1

下载

@语义发布/gitlab

用于发布 GitLab 版本的语义发布插件。

步	描述
`verifyConditions`	验证身份验证的存在和有效性（通过环境变量设置）。
`publish`	发布 GitLab 版本。
`success`	向该版本解决的每个 GitLab 问题或合并请求添加评论。
`fail`	打开或更新 GitLab 问题，其中包含导致发布失败的错误的信息。

安装

$ npm install @semantic-release/gitlab -D

用法

该插件可以在语义发布配置文件中配置：

{
  "branches" : [ " main " ],
  "plugins" : [
    " @semantic-release/commit-analyzer " ,
    " @semantic-release/release-notes-generator " ,
    [
      " @semantic-release/gitlab " ,
      {
        "gitlabUrl" : " https://custom.gitlab.com " ,
        "assets" : [
          { "path" : " dist/asset.min.css " , "label" : " CSS distribution " },
          { "path" : " dist/asset.min.js " , "label" : " JS distribution " , "target" : " generic_package " },
          { "path" : " dist/asset.min.js " , "label" : " v${nextRelease.version}.js " },
          { "url" : " https://gitlab.com/gitlab-org/gitlab/-/blob/master/README.md " }
        ]
      }
    ]
  ]
}

在本示例中，GitLab 版本将发布到https://custom.gitlab.com实例。

配置

亚搏体育appGitLab身份验证

需要GitLab 身份验证配置，可以通过环境变量进行设置。

使用开发人员（或更高级别）角色和api范围创建项目访问令牌、组访问令牌或个人访问令牌，并通过GL_TOKEN环境变量使其在 CI 环境中可用。如果您使用GL_TOKEN作为远程 Git 存储库身份验证，它还必须具有write_repository范围。

注意：使用dryRun运行时，仅需要read_repository范围。

环境变量

多变的	描述
`GL_TOKEN`或`GITLAB_TOKEN`	必需的。用于向 GitLab 进行身份验证的令牌。
`GL_URL`或`GITLAB_URL`	GitLab 端点。
`GL_PREFIX`或`GITLAB_PREFIX`	GitLab API 前缀。
`HTTP_PROXY`或`HTTPS_PROXY`	要使用的 HTTP 或 HTTPS 代理。
`NO_PROXY`	应忽略代理的模式。请参阅下面的详细信息。

代理配置

该插件支持通过代理服务器传递请求。

您可以通过HTTPS_PROXY环境变量配置代理服务器： HTTPS_PROXY=http://proxyurl.com:8080

如果您的代理服务器需要身份验证，请在 URL 中嵌入用户名和密码： HTTPS_PROXY=http://user:[email protected]:8080

如果您的 GitLab 实例通过纯 HTTP 公开（不推荐！），请改用HTTP_PROXY 。

如果需要对某些主机绕过代理，请配置NO_PROXY环境变量： NO_PROXY=*.host.com, host.com

选项

选项	描述	默认
`gitlabUrl`	GitLab 端点。	`GL_URL`或`GITLAB_URL`环境变量或 CI 提供的环境变量（如果在 GitLab CI/CD 或`https://gitlab.com`上运行）。
`gitlabApiPathPrefix`	GitLab API 前缀。	`GL_PREFIX`或`GITLAB_PREFIX`环境变量或 CI 提供的环境变量（如果在 GitLab CI/CD 或`/api/v4`上运行）。
`assets`	要上传到版本的文件数组。查看资产。	-
`milestones`	与版本关联的一系列里程碑标题。请参阅 GitLab 发布 API。	-
`successComment`	添加到该版本解决的每个问题和合并请求的注释。查看成功评论。	？此问题已在版本 ${nextRelease.version} 中得到解决？nn该版本已在 GitLab 版本上提供
`successCommentCondition`	使用此作为条件，何时评论问题或合并请求。请参阅 successCommentCondition。	-
`failComment`	发布失败时创建的问题的内容。请参阅失败注释。	友好的消息，包含语义发布文档和支持的链接，以及导致发布失败的错误列表。
`failTitle`	发布失败时创建的问题的标题。	`The automated release is failing`
`failCommentCondition`	将此作为条件，在发生故障时发表评论或创建问题。请参阅failCommentCondition。	-
`labels`	添加到发布失败时创建的问题的标签。设置为`false`不添加任何标签。标签应该按照官方文档中的描述以逗号分隔，例如`"semantic-release,bot"` 。	`semantic-release`
`assignee`	添加到发布失败时创建的问题的受让人。	-

资产

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

财产	描述	默认
`path`	必需的，除非设置了`url` 。用于标识要上传的文件的 glob。支持 Lodash 模板。	-
`url`	除了设置`path`之外，这还提供了添加版本链接的能力，例如容器镜像的 URL。支持 Lodash 模板。	-
`label`	GitLab 版本上显示的文件的简短描述。如果`path`匹配多个文件则忽略。支持 Lodash 模板。	从`path`中提取的文件名。
`type`	GitLab 版本上显示的资产类型。可以是`runbook` 、 `package` 、 `image` `other` （发布资产见官方文档）。支持 Lodash 模板。	`other`
`filepath`	用于创建指向资产的永久链接的文件路径（需要 GitLab 12.9+，请参阅有关永久链接的官方文档）。如果`path`匹配多个文件则忽略。支持 Lodash 模板。	-
`target`	控制文件上传到的位置。可以设置为`project_upload`以将文件存储为项目上传或`generic_package`以将文件存储为通用包。	`project_upload`
`status`	仅当`target`设置为`generic_package`时才适用。通用包状态。可以`default`和`hidden` （参见通用包的官方文档）。	`default`

assets Array中的每个条目都是单独通配的。 glob 可以是一个String ( "dist/**/*.js"或"dist/mylib.js" ) 或将被组合在一起的String Array ( ["dist/**", "!**/*.css"] ）。

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

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

资产示例

'dist/*.js' ：包含dist目录中的所有js文件，但不包含其子目录中的所有 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文件，并在 GitLab 版本中将它们标记为MyLibrary JS distribution和MyLibrary CSS distribution 。

[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}] : 包含dist目录及其子目录中的所有js和css文件（不包括缩小版），加上build/MyLibrary.zip文件，并在 GitLab 版本中将其标记为MyLibrary 。

成功评论

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

范围	描述
`branch`	具有`name` 、 `type` 、 `channel` 、 `range`和发布完成的分支的`prerelease`属性的`Object` 。
`lastRelease`	具有最新版本的`version` 、 `channel` 、 `gitTag`和`gitHead`的`Object` 。
`nextRelease`	包含`version` 、 `channel` 、 `gitTag` 、 `gitHead`和正在完成的发布的`notes`的`Object` 。
`commits`	包含`hash` 、 `subject` 、 `body` `message`和`author`的提交`Object` `Array` 。
`releases`	包含发布`Array`每个已发布的发布的`Object` ，以及可选的发布数据，例如`name`和`url` 。
`issue`	评论将发布到的 GitLab API Issue 对象，或者在评论合并请求时为`false` 。
`mergeRequest`	评论将发布到的 GitLab API 合并请求对象，或者在评论问题时为`false` 。

成功评论条件

成功评论条件是用Lodash模板生成的。以下变量可用：

范围	描述
`branch`	具有`name` 、 `type` 、 `channel` 、 `range`和发布完成的分支的`prerelease`属性的`Object` 。
`lastRelease`	具有最新版本的`version` 、 `channel` 、 `gitTag`和`gitHead`的`Object` 。
`nextRelease`	包含`version` 、 `channel` 、 `gitTag` 、 `gitHead`和正在完成的发布的`notes`的`Object` 。
`commits`	包含`hash` 、 `subject` 、 `body` `message`和`author`的提交`Object` `Array` 。
`releases`	包含发布`Array`每个已发布的发布的`Object` ，以及可选的发布数据，例如`name`和`url` 。
`issue`	评论将发布到的 GitLab API Issue 对象。
`mergeRequest`	评论将发布到的 GitLab API 合并请求对象。

成功评论条件示例

根本不创建任何注释：设置为false或模板化： "<% return false; %>"
仅对问题发表评论： "<% return issue %>"
仅评论合并请求： "<% return mergeRequest %>"
您可以使用标签来过滤问题： "<% return issue.labels?.includes('semantic-release-relevant') %>"

检查 GitLab API 合并请求对象或 GitLab API 问题对象以获取可用于过滤器的属性

评论失败

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

范围	描述
`branch`	发布失败的分支。
`errors`	SemanticReleaseError `Array` 。每个错误都有`message` 、 `code` 、 `pluginName`和`details`属性。 `pluginName`包含引发错误的插件的包名称。 `details`包含有关 Markdown 格式的错误的信息。

失败评论示例

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

由于以下错误，分支主版本的此版本失败：
错误信息1
错误信息2

失败评论条件

失败注释条件是使用 Lodash 模板生成的。以下变量可用：

范围	描述
`branch`	具有`name` 、 `type` 、 `channel` 、 `range`和发布完成的分支的`prerelease`属性的`Object` 。
`lastRelease`	具有最新版本的`version` 、 `channel` 、 `gitTag`和`gitHead`的`Object` 。
`nextRelease`	包含`version` 、 `channel` 、 `gitTag` 、 `gitHead`和正在完成的发布的`notes`的`Object` 。
`commits`	包含`hash` 、 `subject` 、 `body` `message`和`author`的提交`Object` `Array` 。
`releases`	包含发布`Array`每个已发布的发布的`Object` ，以及可选的发布数据，例如`name`和`url` 。
`issue`	评论将发布到的 GitLab API Issue 对象 - 仅在存在未决问题时可用。

失败注释条件示例

根本不创建任何注释：设置为false或模板化： "<% return false; %>"
仅对主分支进行评论： "<% return branch.name === 'main' %>"
您可以使用标签来过滤问题，即如果问题标有wip ，则不发表评论： "<% return !issue.labels?.includes('wip') %>"