@lets-release/gitlab v1.2.2

@lets-release/gitlab

lets-release plugin for publishing a GitLab release.

Usage

The plugin can be configured in the lets-release configuration file:

{
  "branches": ["main"],
  "plugins": [
    "@lets-release/commit-analyzer",
    "@lets-release/release-notes-generator",
    [
      "@lets-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" }
        ]
      }
    ]
  ]
}

In this example, GitLab releases will be published to the https://custom.gitlab.com instance.

Configuration

GitLab authentication

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

There are three kinds of tokens, see @gitbeaker/rest for details. The personal token can be set using the GL_TOKEN or GITLAB_TOKEN environment variable.

The token must have the api scope. If you are using the token for remote Git repository authentication, it must also have the write_repository scope.

Note: When running with dryRun, only the read_repository scope is required.

Environment variables

Options

assets

Can be a glob, an Array of globs, or an Object with the following properties:

Each entry in the assets Array is globed individually. A glob can be a String ("dist/**/*.js" or "dist/mylib.js") or an Array of Strings that will be globed together (["dist/**", "!**/*.css"]).

If a directory is configured, all the files under this directory and its subdirectories will be included.

The label for each asset is generated with Lodash template. The following variables are available:

Note: If a file matches an entry in assets, it will be included even if it also has a match in .gitignore.

assets examples

'dist/*.js': includes all the js files in the dist directory, but not in its subdirectories.

[['dist', '!**/*.css']]: includes all the files in the dist directory and its subdirectories excluding the css files.

[{path: 'dist/MyLibrary.js', label: 'MyLibrary JS distribution'}, {path: 'dist/MyLibrary.css', label: 'MyLibrary CSS distribution'}]: includes the dist/MyLibrary.js and dist/MyLibrary.css files, and labels them MyLibrary JS distribution and MyLibrary CSS distribution in the GitLab release.

[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}]: includes all the js and css files in the dist directory and its subdirectories excluding the minified version, plus the build/MyLibrary.zip file and labels it MyLibrary in the GitLab release.

commentOnSuccess

A boolean or a function that returns a boolean or Promise<boolean> to determine whether to comment on issues and merge requests on success. The following variables are available:

successComment

The message for the issue comments is generated with Lodash template. The following variables are available:

successLabels

Each label name is generated with Lodash template. The following variables are available:

Compatibility

The latest version of this plugin is compatible with all currently supported versions of GitLab, which is the current major version and previous two major versions. This plugin is not guaranteed to work with unsupported versions of GitLab.