Skip to content

Using xbar, an OSS that allows displaying anything on the macOS menu bar, this plugin shows the status of PipeCD.

License

Notifications You must be signed in to change notification settings

BIwashi/xpipecd-xbar

Repository files navigation

xpipecd-xbar

Using xbar, an OSS that allows displaying anything on the macOS menu bar, this plugin shows the status of PipeCD.

matryer/xbar: Put the output from any script or program into your macOS Menu Bar (the BitBar reboot)

bar

How to setup

  1. Install xbar
$ brew install xbar
  1. Install the plugin
$ git clone git@github.com:BIwashi/xpipecd-xbar.git
$ cd xpipecd-xbar
$ make setup/cli

To change the API call interval (default is 30s), do the following:

$ make setup/cli t=60s
  1. Setup xbar config

Open xbar Plugin settings (Open Plugin)

Open Plugin

Activate by selecting xpipecd-xbar.{time}.sh Set PIPECD_API_KEY to your PipeCD API Key (read only) Set PIPECD_HOST to your PipeCD Host

Setup PipeCD Config

Mechanism

The xbar plugin is a script that runs at regular intervals, with xbar displaying its standard output on the menu bar. The execution frequency is expressed in the file name.

{plugin_name}.{time}.{ext}

The plugin can be used by placing it in the following directory.

$(HOME)/Library/Application\ Support/xbar/plugins/

make setup/cli performs the following operations:

  1. Uses the internal implementation of PipeCD's CLI, pipectl, to make API calls to the PipeCD control plane
  2. Builds the above implementation
  3. Creates a symbolic link in $(HOME)/Library/Application\ Support/xbar/plugins/ for the shell script xpipecd-xbar.sh and the built executable itself