Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ye11ow/noti
Noti is a Mac OS X menu bar plugin to show the status of pull requests
https://github.com/ye11ow/noti
github gitlab gitlab-ci macos travis-ci xbar-plugin
Last synced: 26 days ago
JSON representation
Noti is a Mac OS X menu bar plugin to show the status of pull requests
- Host: GitHub
- URL: https://github.com/ye11ow/noti
- Owner: ye11ow
- License: mit
- Created: 2019-12-17T04:43:24.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-10-01T22:58:04.000Z (about 3 years ago)
- Last Synced: 2024-06-14T01:39:37.417Z (6 months ago)
- Topics: github, gitlab, gitlab-ci, macos, travis-ci, xbar-plugin
- Language: Python
- Homepage: https://ye11ow.github.io/noti/
- Size: 602 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Mac-Menubar-Megalist - Noti
README
# Noti
[](https://github.com/ye11ow/noti/actions)
[](https://coveralls.io/github/ye11ow/noti?branch=main)
Noti is a Mac OS X menu bar plugin to show the status of pull requests (merge requests). It is distributed as a plugin of [xbar](https://xbarapp.com/)(former **Bitbar**).
* The background color indicate the status of the CI job behind this pull request
* Green: Job passed
* Blue: Job is running
* Red: Job failed
* Emojis:
* 👍: Pull request is approved (or approval is optional)
* 🏃: The CI job is running
* 🙃: Number of pull requests that failed the CI job
* 💬: Number of pull reuqest comments
## Installation
1. Make sure both `xbar` and `python3` (>=3.6) are installed on your machine.
1. Clone this repo and move `noti.py` to your xbar plugin folder as `noti.{time}.py`. The `{time}` is the refresh interval. For instance, renaming to `noti.30s.py` will lead to a 30 seconds' refresh interval. For detailed instruction, you can refer to https://github.com/matryer/xbar-plugins/blob/main/CONTRIBUTING.md#configure-the-refresh-time.
1. Edit the shebang of `noti.{time}.py` to make sure it points to the right Python interpreter (default `/usr/local/bin/python3`).
1. Install the python dependencies `/usr/local/bin/python3 -m pip install -r requirements.txt`.
1. Configure noti to connect to your Gitlab or Github. You can either edit the config file under `$HOME/.noticonfig.json` or select `Configure noti` on the dropdown menu. Please refer to the Configurations section for details.
1. You should be able to see the status on your menubar if everything is setup properly. Enjoy!😃.
## Configurations
```javascript
// Noti will automatically create this file under $HOME/.noticonfig.json if it doesn't exist
{
// Gitlab related configurations
"gitlab": {
// [REQUIRED] Go to the "User Settings" -> "Access Tokens" page, create a Personal Access Token with "api" Scopes
"token": "",
// [REQUIRED] Go to the home page of the repo, you will find the Project ID under the name of the repo (in grey).
"project_id": [],
// [Optional] The host of the gitlab server. Leave it empty to use the public Gitlab server.
"host": "",
// [Optional] Filters
"filters": {
// Filter by the usernames. The username here is the @ ID
"usernames": []
}
},
// Github related configurations
"github": {
// [REQUIRED] Go to Github "Settings" -> "Developer settings" -> "Personal access tokens" and "Generate new token" with "repo" scopes
"token": "",
// [REQUIRED] The name of the repo. e.g. "ye11ow/noti"
"repo": [],
// [Optional] The host of the github server. Leave it empty to use the public Github server.
"host": "",
// [Optional] Filters
"filters": {
// Filter by the usernames. The username here is the ID. e.g. https://github.com/ye11ow ye11ow is the username.
"usernames": []
}
},
// [Optional] Customize the emoji
"emoji": {
// Show on the title when there isn't any status
"good_day": "😃",
// The MR is approved
"approved": "👍",
// The pipeline behind this MR is currently running
"running": "🏃",
// The pipeline is failed
"failed": "🙃",
// Number of comments
"comments": "💬"
}
}
```
## Features
### Supported VCS
- [X] Gitlab + Gitlab pipeline
- [X] Github + Travis CI
- [ ] Github + Github Action
- [ ] Bitbucket + Bitbucket pipeline
### Supported GUI
- [X] xbar
- [ ] Native Mac app
- [ ] VS Code
- [ ] Terminal ([WTF](https://wtfutil.com/) maybe?)