https://github.com/koki-develop/xbar-plugin-github
An xbar plugin to display GitHub Pull Requests and notifications.
https://github.com/koki-develop/xbar-plugin-github
Last synced: 4 months ago
JSON representation
An xbar plugin to display GitHub Pull Requests and notifications.
- Host: GitHub
- URL: https://github.com/koki-develop/xbar-plugin-github
- Owner: koki-develop
- License: mit
- Created: 2024-01-14T07:01:02.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-07T00:18:09.000Z (over 1 year ago)
- Last Synced: 2025-03-23T03:51:12.657Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 563 KB
- Stars: 30
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xbar Plugin for GitHub
## Prerequisites
`node` is required to be installed with Homebrew.
```console
$ brew install node
```
## Installation
### Clone repository
```console
$ git clone git@github.com:koki-develop/xbar-plugin-github
$ cd xbar-plugin-github
$ make
```
A symbolic link is created in `~/Library/Application Support/xbar/plugins/github.5m.js`.
### Install directly
```console
$ wget https://raw.githubusercontent.com/koki-develop/xbar-plugin-github/main/github.5m.js -P ~/Library/Application\ Support/xbar/plugins/
$ chmod +x ~/Library/Application\ Support/xbar/plugins/github.5m.js
```
## Configuration
- `GITHUB_TOKEN` : Your GitHub Personal Access Token.
- `SHOW_REVIEW_REQUESTED` : Show Pull Requests that are requested to review.
- `SHOW_MY_PULL_REQUESTS` : Show your Pull Requests.
- `SHOW_NOTIFICATIONS` : Show your notifications.
- `SHOW_PULL_REQUEST_STATUS` : Show Pull Request's status.
- `SHOW_PULL_REQUEST_BRANCHES` : Show Pull Request's base/head branches.
- `SHOW_NOTIFICATION_REASON` : Show notification's reason.
- `INCLUDE_BOT_PULL_REQUESTS` : Include Pull Requests created by bots.
- `GITHUB_HOST` : Your GitHub Enterprise Host. Leave blank for GitHub.com.
## LICENSE
[MIT](./LICENSE)