Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sshaw/build-status
Emacs minor mode that monitors and shows a buffer's build status in the mode line.
https://github.com/sshaw/build-status
build ci circleci emacs mode mode-line travis-ci
Last synced: 17 days ago
JSON representation
Emacs minor mode that monitors and shows a buffer's build status in the mode line.
- Host: GitHub
- URL: https://github.com/sshaw/build-status
- Owner: sshaw
- Created: 2017-01-17T01:31:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-08-07T12:31:48.000Z (over 5 years ago)
- Last Synced: 2024-12-01T18:45:06.631Z (about 1 month ago)
- Topics: build, ci, circleci, emacs, mode, mode-line, travis-ci
- Language: Emacs Lisp
- Homepage:
- Size: 74.2 KB
- Stars: 27
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# build-status
Emacs minor mode that shows a buffer's build status in the mode line.
## Installation
From MELPA
Run `M-x package-install` `build-status`
Manual installation
Add `build-status.el`'s directory to `load-path`
```el
(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:
* failed
* passed
* queued
* running
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](#supported-services) 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](https://www.gnu.org/software/emacs/manual/html_node/elisp/Attribute-Functions.html#Attribute-Functions).
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](#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](#usage)):
```el
(setq build-status-circle-ci-token "YOUR-TOKEN")
```
Status mapping is controlled via `build-status-circle-ci-status-mapping-alist`. It
defaults to:
```el
'(("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](#usage)):
```el
(setq build-status-travis-ci-token "YOUR-TOKEN")
```
Status mapping is controlled via `build-status-travis-ci-status-mapping-alist`. It
defaults to:
```el
'(("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](https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html#Directory-Variables)
are a good way to set up domain and token on a per-project basis.
## TODOs
* Support for Enterprise GitHub
* Support for VCS mode hooks
* Support for AppVeyor
## See Also
* [jenkins-watch](https://github.com/ataylor284/jenkins-watch)
* [github-notifier](https://github.com/xuchunyang/github-notifier.el)
## Author
Skye Shaw [skye.shaw AT gmail.com]