Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 3.34 KB

readme.md

File metadata and controls

54 lines (37 loc) · 3.34 KB
Raw

GitLab Merge Request Reminder

Docker Image Version (latest semver)

Sends a notification to a Slack webhook highlighting open merge requests for a given GitLab repository. If no merge requests are open, then no notification will be sent.

Environment Variables

Variable Details Example Values
GITLAB_URL The URL of the Gitlab server. Defaults to https://gitlab.com https://gitlab.company.com
GITLAB_ACCESS_TOKEN The access token for the GitLab repository. This needs at least read_api access and be done by following the Gitlab instructions.
GITLAB_PROJECT_IDS The GitLab project ids the merge requests are for. This should be comma separated (e.g. 12345,678910) 12345,678910
INCLUDE_WIP Determines if work in progress merge requests should be included. This is true by default. true or false
INCLUDE_DRAFT Determines if draft merge requests should be included. This is true by default. true or false
GITLAB_MANDATORY_LABELS The labels that merge requests must have assigned to them. All labels must be present. This should be comma separated (e.g. mandatory-label-1,mandatory-label-2) mandatory-label-1,mandatory-label-2
GITLAB_EXCLUDED_LABELS The labels that merge requests must not have assigned to them. Any label must be present for the merge request to be ignored. This should be comma separated (e.g. excluded-label-1,excluded-label-2) excluded-label-1,excluded-label-2
SLACK_WEBHOOK_URL The URL of the slack incoming webhook to send the notification to.
SLACK_TARGET The target of the slack message. This is @here by default. @here

Docker

This is available as a docker image, available on docker hub.

Example Uses

Because the logic is within a docker image, it can be run in a variety of places. Below I'll document examples of use.

Gitlab Job

You could create a gitlab job which is run on a schedule. For example

merge-request-reminder:
  stage: notify
  image: bottlecapdave/gitlab-merge-request-reminder:v1.5.0
  only:
    refs:
      - schedules
  script:
    - node /app/lib/index.js

Build

You can run npm run docker-build to build a local docker image, which can then be run locally.

Releases

To release a new version, merge into main. The github CI will then create a release based on the commitizen messages.

Sponsorships

If you find this useful, please consider a one time or monthly GitHub sponsorship.