gitlab-rancher-config

Semantic-release shareable config for GitLab with Rancher.

Usage

Local installation

npm i -D semantic-release gitlab-rancher-config

In package.json:

{
  "release": {
    "extends": "gitlab-rancher-config"  
  }
}

Global installation

$ npm i -g semantic-release gitlab-rancher-config @semantic-release/{changelog,git,gitlab,npm} semantic-release-gitlab-registry semantic-release-rancher
$ semantic-release -e gitlab-rancher-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
PLUGIN_SERVICE	Required. Stack name and service name. Ex: my_stack/my_name
RANCHER_ACCESS_KEY	Required. A valid environment API access key
RANCHER_SECRET_KEY	Required. A valid environment API secret key
RANCHER_URL	Required. The environment API endpoint. Ex: https://rancher.domain.com/v1/projects/{ID}

Additional options

This shareable config uses the @semantic-release/changelog, @semantic-release/git, @semantic-release/gitlab, @semantic-release/npm, semantic-release-gitlab-registry and semantic-release-rancher 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": "gitlab-rancher-config",
    "gitlabUrl": "https://custom.gitlab.com"
  }
}

License

MIT