/gitlab-config

:fox_face: Semantic-release shareable config for GitLab

Primary LanguageJavaScriptMIT LicenseMIT

@semantic-release/gitlab-config

Semantic-release shareable config for GitLab.

Travis Codecov Greenkeeper badge

npm latest version npm next version

Usage

Local installation

$ npm install --save-dev semantic-release @semantic-release/gitlab-config

In package.json:

{
  "release": {
    "extends": "@semantic-release/gitlab-config"  
  }
}

Global installation

$ npm install -g semantic-release @semantic-release/gitlab-config
$ semantic-release -e @semantic-release/gitlab-config

Configuration

GitLab authentication

The GitLab authentication configuration is required and can be set via environment variables.

See GitLab authentication.

Npm registry authentication

The npm authentication configuration is required and can be set via environment variables.

See Npm registry authentication

Environment variables

Variable Description
GL_TOKEN or GITLAB_TOKEN Required. The token used to authenticate with GitLab repository.
NPM_TOKEN Required. Npm token created via npm token create

Additional options

This shareable config uses the @semantic-release/npm and @semantic-release/gitlab plugins. See the documentation of each plugins for additional options. Options can be set in the Semantic-release configuration.

For example to set a custom GitLab URL:

{
  "release": {
    "extends": "@semantic-release/gitlab-config",
    "gitlabUrl": "https://custom.gitlab.com"
  }
}