get-ci-env

get-ci-env

Get and normalize the environment variables from continuous integration services. This package is similar to pvdlg's env-ci but goes for a simpler approach. This results in a more restricted and lightweight (zero dependencies) package:

• Only CI services that contain all values in the environment are supported, taking away the need to manually check the returned data.
• Return a promise to indicate if a valid CI environment is detected for explicit error handling.
• Logically nested data for concise naming and easy detection of pull request context: if (ciEnvOutput.pr) { ... }.

Install

npm install get-ci-env

Usage

Example usage when running inside CircleCI:

import getCiEnv from 'get-ci-env';

getCiEnv().then(console.log);

Resulting in the output:

{
  service: 'circleCi',
  branch: 'master',
  commit: 'abc',
  repo: { owner: 'Selwyn', name: 'hedgehogs' },
  pr: { number: '3' },
}

Supported services

• Buildkite
• CircleCI
• Codefresh
• GitLab CI
• Travis CI

Variables

• service: Camel-cased CI service name
• branch: Branch name containing the relevant commit
• commit: Commit SHA hash that triggered the CI build
• repo:
  • owner: Name of the repository owner
  • name: Repository name
• pr: Only set when triggered by a pull request
  • number: Pull request number

API

getCiEnv(env)

env

Type: object
Default: process.env
The user environment.

Changelog

[1.3.0] - 2019-01-22

Added

• Buildkite support.
• ESM export output, so both require('get-ci-env') and import getCiEnv from 'get-ci-env' work!