env-ci

Get environment variables exposed by CI services.

Adapted from codecov-node.

Install

$ npm install --save env-ci

Usage

const envCi = require('env-ci');

const {isCi, name, service, commit, build, buildUrl, branch, job, jobUrl, pr, isPr, slug, root} = envCi();

if (isCI) {
  console.log(`Building branch ${branch} of repo ${slug} on ${name}`);

  if (isPr) {
    console.log(`Building Pull Request #${pr}`);
  }

  if (service === 'travis') {
    // Do something specific to Travis CI
  }
}

Variables

Supported CI

If none of the above CI services is detected, commit and branch are determined based on the local Git repository, and isCi is determined based on the CI environment variable.

Caveats

Git branch determination

Certain CI services don't provide an environment variable to determine the current Git branch being built. In such cases the branch is determined with the command git rev-parse --abbrev-ref HEAD.

However, if the local repository is in a detached head state the branch cannot be determined directly. In such case, env-ci will look for the remote branches having the same HEAD as the local detached HEAD to determine the branch from which the detached HEAD was created.

In the rare case where there is multiple remote branches with the same HEAD as the local detached HEAD, env-ci will arbitrarily pick the first one. This can lead to an inaccurate branch value for certain CI services in such circumstances.

Affected CI services:

• AWS CodeBuild