reg-notify-gitlab-plugin

Notify reg-suit result to GitLab repository

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
reg-notify-gitlab-plugin
1,136540.14.419 days ago6 years agoMinified + gzip package size for reg-notify-gitlab-plugin in KB

Readme

reg-notify-gitlab-plugin
reg-suit plugin to send notification the testing result to your GitLab repository.
Installing this plugin, reg-suit comments to your Merge Request.

Install

npm i reg-notify-gitlab-plugin -D
reg-suit prepare -p notify-gitlab

Configure

{
  projectId: string;
  privateToken: string;
  gitlabUrl?: string;
  commentTo?: "note" | "description" | "discussion";
  shortDescription?: boolean;
}

  • projectId - Required - Your GitLab project id. You can get this id via https://gitlab.com/<your-name>/<your-project-name/edit> page.
  • privateToken - Required - Your GitLab API token. If you want more detail, see Personal access tokens doc.
  • gitlabUrl - Optional - Set if you host your GitLab instance. Default: https://gitlab.com
  • commentTo - Optional - How this plugin comments to MR. If "note", it posts or puts the comment as a MR's note. if "description", your MR's description gets updated. If "discussion", it posts or puts the comment as a MR's resolvable note. Default: "note".
  • shortDescription - Optional Returns a small table with the item counts.
Example:
| 🔴 Changed | ⚪️ New | 🔵 Passing | | ---------- | ------- | ---------- | | 3 | 4 | 120 |

Auto complete on GitLab CI

If you run reg-suit on GitLab CI, this plugin detect gitlabUrl and projectId values from pre-declared GitLab CI environment values. So you can skip projectId