CircleCI API

Bindings for the CircleCI API.

Features

• Automatic authentication via API token
• Automatic pagination of list endpoints (fetch up to N pages in one call)
• Asynchronous by default
• Transparent JSON deserialisation
• Backed by the excellent request library

Installing

Simply grab it from MELPA.

use-package

(use-package circleci-api
  :ensure t)

straight.el

(straight-use-package 'circleci-api)

package.el

Ensure you have MELPA available.

M-x package-install RET circleci-api RET.

Manual

Just fetch circleci-api.el, save it somewhere and load it into Emacs.

Configuration

M-x customize-group RET circleci RET, or manually by setting the following variables:

circleci-api-token

The CircleCI API token (default: not set)

circleci-api-host

The CircleCI API host (default: https://circleci.com)

Use

This package exports a long list of functions named circleci-*. M-x apropos RET circleci RET can help with discovery.

Coverage

• [X] Project
• [X] Pipeline by ID
• [X] Pipeline config
• [X] Pipeline workflows
• [X] Pipelines by org
• [X] Pipelines by project
• [X] Pipelines by user
• [X] Trigger pipeline
• [X] Workflow by ID
• [X] Workflow jobs
• [X] Cancel workflow
• [X] Rerun workflow
• [X] Approve a job

Anything not included in the list above is not implemented yet.