search

sshaw / build-status

Emacs minor mode that monitors and shows a buffer's build status in the mode line.
27 stars 2 forks source link
build ci circleci emacs mode mode-line travis-ci

readme

build-status

Emacs minor mode that shows a buffer's build status in the mode line.

build-status example running build-status example passing build-status example failing

Installation

From MELPA

Run M-x package-install build-status

Manual installation

Add build-status.el's directory to load-path

(require 'build-status)
(put 'build-status-mode-line-string 'risky-local-variable t)

Usage

M-x build-status-mode in a buffer that's part of a CI project.

By default the build status will be checked every 5 minutes. To change this set build-status-check-interval to the desired interval, in seconds.

API tokens can be set via the service-specific variable (see below) or via git config:

git config --add build-status.api-token TOKEN

To open the CI service's web page for buffer's build click on the mode's lighter or run M-x build-status-open.

Status Mapping

build-status will try to convert the CI service's status to one of the following:

This is done via the service's status mapping alist.

If the status is not mapped it's treated as unknown (lighter is "?" and mouseover shows the status as is). You can ignore a status by mapping it to the symbol ignored.

See the Supported Services section below for more information.

Status Mode Line Faces

Each status indicator has an associated face. They're are listed below.

If you'd like to change the color and/or style of an indicator just update the appropriate face.

You can add a face for an unsupported status by creating a face named build-status-STATUS-face where STATUS is the name of the status with non-word characters replaced by "-".

build-status-face

All faces inherit from this face.

Attributes: none

build-status-failed-face

Attributes: :background "red"

build-status-passed-face

Attributes: :background "green"

build-status-queued-face

Attributes: :background "yellow"

build-status-running-face

Attributes: :background "yellow"

build-status-unknown-face

Used when the build status returns an unknown value. For more info see status mapping.

Attributes: none

Supported Services

CircleCI

The buffer's directory or one of its ancestors must contain a circle.yml file or .circleci directory.

To set a token (but also see git config tokens):

(setq build-status-circle-ci-token "YOUR-TOKEN")

Status mapping is controlled via build-status-circle-ci-status-mapping-alist. It defaults to:

'(("infrastructure_fail" . "failed")
  ("not_running" . "queued")
  ("success" . "passed")
  ("scheduled" . "queued")
  ("timedout" . "failed"))

Travis CI

The buffer's directory or one of its ancestors must contain a .travis.yml file.

To set a token (but also see git config tokens):

(setq build-status-travis-ci-token "YOUR-TOKEN")

Status mapping is controlled via build-status-travis-ci-status-mapping-alist. It defaults to:

'(("errored" . "failed")
  ("started" . "running")
  ("created" . "queued"))

By default, the open source Travis CI (travis-ci.org) is used. To use the pro or enterprise versions, set the build-status-travis-ci-domain variable to travis-ci.com, or the domain of your enterprise instance. If you have projects in both, directory variables are a good way to set up domain and token on a per-project basis.

TODOs

See Also

Author

Skye Shaw [skye.shaw AT gmail.com]