https://github.com/bottlecapdave/gitlab-merge-request-reminder
Sends reminders for all open merge requests for given gitlab projects
https://github.com/bottlecapdave/gitlab-merge-request-reminder
docker-image dockerfile gitlab nodejs slack
Last synced: 25 days ago
JSON representation
Sends reminders for all open merge requests for given gitlab projects
- Host: GitHub
- URL: https://github.com/bottlecapdave/gitlab-merge-request-reminder
- Owner: BottlecapDave
- License: mit
- Created: 2020-09-20T15:08:51.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-15T16:00:23.000Z (about 1 year ago)
- Last Synced: 2025-04-06T05:54:34.884Z (27 days ago)
- Topics: docker-image, dockerfile, gitlab, nodejs, slack
- Language: TypeScript
- Homepage:
- Size: 792 KB
- Stars: 14
- Watchers: 1
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# GitLab Merge Request Reminder
[](https://hub.docker.com/r/bottlecapdave/gitlab-merge-request-reminder) [](https://github.com/sponsors/bottlecapdave)
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](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html). | |
| 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](https://hub.docker.com/r/bottlecapdave/gitlab-merge-request-reminder).
## 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](https://docs.gitlab.com/ce/ci/pipelines/schedules.html). 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](https://github.com/sponsors/bottlecapdave).