semantic-release plugin to publish a GitLab release.
Step | Description |
---|---|
verifyConditions |
Verify the presence and the validity of the authentication (set via environment variables). |
publish |
Publish a GitLab release. |
$ npm install @semantic-release/gitlab -D
The plugin can be configured in the semantic-release configuration file:
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
["@semantic-release/gitlab", {
"gitlabUrl": "https://custom.gitlab.com"
}],
]
}
With this example GitLab releases will be published to the https://custom.gitlab.com
instance.
The GitLab authentication configuration is required and can be set via environment variables.
Only the personal access token authentication is supported.
Variable | Description |
---|---|
GL_TOKEN or GITLAB_TOKEN |
Required. The token used to authenticate with GitLab. |
GL_URL or GITLAB_URL |
The GitLab endpoint. |
GL_PREFIX or GITLAB_PREFIX |
The GitLab API prefix. |
Option | Description | Default |
---|---|---|
gitlabUrl |
The GitLab endpoint. | GL_URL or GITLAB_URL environment variable or https://gitlab.com . |
gitlabApiPathPrefix |
The GitLab API prefix. | GL_PREFIX or GITLAB_PREFIX environment variable or /api/v4 . |