@semantic-release/gitlab
Set of Semantic-release plugins for publishing a GitLab release.
verifyConditions
Verify the presence and the validity of the authentication (set via environment variables).
publish
Publish a GitLab release.
Configuration
GitLab authentication
The GitLab authentication configuration is required and can be set via environment variables.
Only the personal access token authentication is supported.
Environment variables
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. |
Options
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 . |
Usage
Options can be set within the plugin definition in the Semantic-release configuration file:
{
"release": {
"verifyConditions": [
"@semantic-release/npm",
"@semantic-release/git",
{
"path": "@semantic-release/gitlab",
"gitlabUrl": "https://custom.gitlab.com"
}
],
"publish": [
"@semantic-release/npm",
"@semantic-release/git",
{
"path": "@semantic-release/gitlab",
"gitlabUrl": "https://custom.gitlab.com"
}
]
}
}