# merge-request-notifier

**Repository Path**: mirrors_codecentric/merge-request-notifier

## Basic Information

- **Project Name**: merge-request-notifier
- **Description**: This app shows your merge requests grouped by projects and WIP status. It is accessible from the system tray.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2025-10-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Merge Request Notifier

This app shows your **GitLab** merge requests grouped by projects and WIP status. It is accessible from the system tray.

| Light Mode  | Dark Mode |
| ------------- | ------------- |
| <img src="./images/app.png" width=500 alt="App Screenshot (Light Mode)"> | <img src="./images/app-dark-mode.png" width=500 alt="App Screenshot (Dark Mode)"> |

## Tray Icon
In the system tray you wil see the number of all open merge requests.

<img src="./images/tray.png" width=1000 alt="System Tray">

## Notification
You will receive a desktop notification when a new merge request is created. 
If you are not interested in "work in progress" merge request you can disable notifications for these. In addition you can disable notifications at all. 

<img src="./images/notification.png" width=500 alt="Notification Screenshot">

## App Updates (macOS only)
You will be always up to date with our integrated in app updates 🎉. Once there is a new update available you will be 
notified with a prominent alert above the merge requests. On the details page you find the release notes from github. 

| New Update Alert  | Release Notes |
| ------------- | ------------- |
| <img src="./images/new-update-alert.png" width=500 alt="New Update Alert"> | <img src="./images/update-info.png" width=500 alt="Release Notes"> |

## Installation
### macOS
#### Manual installation
The macOS installer is uploaded at the [releases page](https://github.com/codecentric/merge-request-notifier/releases). Please download and install.

#### With homebrew-cask
If you're using homebrew-cask, this app can be installed via it. Please tap the repository URL and install this app via brew cask as follows.

```
brew tap codecentric/merge-request-notifier https://github.com/codecentric/merge-request-notifier
brew install --cask merge-request-notifier
```
It's the easiest way to install and manage this app on macOS.

### Windows
The Windows installer is uploaded at the [releases page](https://github.com/codecentric/merge-request-notifier/releases). Please download and install.

### Linux
#### Dependencies
This app is using a library that uses `libsecret` to store the personal access token on your device.

Depending on your distribution, you will need to run the following command:
* Debian/Ubuntu: sudo apt-get install libsecret-1-dev
* Red Hat-based: sudo yum install libsecret-devel
* Arch Linux: sudo pacman -S libsecret

#### Arch Linux
merge-request-notifier is available from the [AUR](https://aur.archlinux.org/packages/merge-request-notifier/). Install it using yay (or any other AUR helper):

```
$ yay -S merge-request-notifier
```

#### Other
Check the [releases](https://github.com/codecentric/merge-request-notifier/releases) page for packages for your distribution.

## Development
### Install all dependencies 

```bash
yarn install
```

### Usage
This will start the application with hot-reload so you can instantly start developing your application.

```bash
# start the renderer process with webpack-dev-server
yarn start-renderer

# start the main process (electron app)
yarn start-main
```

### Logs
You will find the application logs in the following folders

| OS  | Folder |
| ------------- | ------------- |
| Linux | ~/.config/merge-request-notifier/logs/{process type}.log |
| macOS | ~/Library/Logs/merge-request-notifier/{process type}.log |
| Windows | %USERPROFILE%\AppData\Roaming\merge-request-notifier\logs\{process type}.log |

### App Settings
You will find the application settings in the following folders

| OS  | Folder |
| ------------- | ------------- |
| Linux | $XDG_CONFIG_HOME/merge-request-notifier/Settings or ~/.config/merge-request-notifier/Settings |
| macOS | ~/Library/Application\ Support/merge-request-notifier/Settings |
| Windows | %APPDATA%/merge-request-notifier/Settings |

### New Releases
#### Create a new Release and Publish it
```bash
yarn dist
```