Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.44 KB

README.md

File metadata and controls

36 lines (23 loc) · 1.44 KB

xbar PR status

This is an xbar plugin that creates a view of your open GitHub PRs and their CI/approval/automerge status. The menubar item opens to a list of linked PRs, with further expansion to a list of checks on each PR.

Installing

This repo is managed using Nix, so you can do something like:

cachix use xbar-pr-status # if you have cachix installed
nix-env -if https://github.com/BrianHicks/xbar-pr-status/archive/refs/heads/main.tar.gz

If you have a Rust toolchain set up, you can also clone this repo and run cargo build.

Setting Up

Create a personal GitHub access token in your developer settings. It needs the repo (all) and read:user scopes (you can see the exact query we make at src/pull_requests.graphql.)

After you install xbar-pr-status, create a new plugin like ~/Library/Application Support/xbar/plugins/prs.5m.sh that looks like this:

#!/usr/bin/env bash
xbar-pr-status ghp_AAAAAAAAAAA

Make that file executable (chmod +x) and tell xbar to reload all plugins to pick it up. (You should also be able to run it yourself to check if things look OK.)

If you want to customize the emojis used, run xbar-pr-status --help to see the options available to you.

License

xbar-pr-status is licensed under The Hippocratic License, version 3.0. See LICENSE in the source for the applicable modules to this project.