Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codecentric/merge-request-notifier
This app shows your merge requests grouped by projects and WIP status. It is accessible from the system tray.
https://github.com/codecentric/merge-request-notifier
github gitlab merge-requests notification-service notifications pull-requests
Last synced: 3 months ago
JSON representation
This app shows your merge requests grouped by projects and WIP status. It is accessible from the system tray.
- Host: GitHub
- URL: https://github.com/codecentric/merge-request-notifier
- Owner: codecentric
- License: mit
- Created: 2019-08-25T00:22:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T04:58:06.000Z (almost 2 years ago)
- Last Synced: 2023-03-22T13:44:47.188Z (almost 2 years ago)
- Topics: github, gitlab, merge-requests, notification-service, notifications, pull-requests
- Language: TypeScript
- Homepage:
- Size: 11.1 MB
- Stars: 46
- Watchers: 5
- Forks: 7
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
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 |
| ------------- | ------------- |
| 
| 
|
## Tray Icon
In the system tray you wil see the number of all open merge requests.
## 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.
## 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 |
| ------------- | ------------- |
| 
| 
|
## 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
```