jhladmin/node_modules/ci-info

ci-info

Get details about the current Continuous Integration environment.

Please open an issue if your CI server isn't properly detected :)

Installation

npm install ci-info --save

Usage

var ci = require('ci-info')

if (ci.isCI) {
  console.log('The name of the CI server is:', ci.name)
} else {
  console.log('This program is not running on a CI server')
}

Supported CI tools

Officially supported CI servers:

Name	Constant
AWS CodeBuild	ci.CODEBUILD
AppVeyor	ci.APPVEYOR
Bamboo by Atlassian	ci.BAMBOO
Bitbucket Pipelines	ci.BITBUCKET
Bitrise	ci.BITRISE
Buddy	ci.BUDDY
Buildkite	ci.BUILDKITE
CircleCI	ci.CIRCLE
Cirrus CI	ci.CIRRUS
Codeship	ci.CODESHIP
Drone	ci.DRONE
dsari	ci.DSARI
GitLab CI	ci.GITLAB
GoCD	ci.GOCD
Hudson	ci.HUDSON
Jenkins CI	ci.JENKINS
Magnum CI	ci.MAGNUM
Sail CI	ci.SAIL
Semaphore	ci.SEMAPHORE
Shippable	ci.SHIPPABLE
Solano CI	ci.SOLANO
Strider CD	ci.STRIDER
TaskCluster	ci.TASKCLUSTER
Team Foundation Server by Microsoft	ci.TFS
TeamCity by JetBrains	ci.TEAMCITY
Travis CI	ci.TRAVIS

API

ci.name

A string. Will contain the name of the CI server the code is running on. If not CI server is detected, it will be null.

Don't depend on the value of this string not to change for a specific vendor. If you find your self writing ci.name === 'Travis CI', you most likely want to use ci.TRAVIS instead.

ci.isCI

A boolean. Will be true if the code is running on a CI server. Otherwise false.

Some CI servers not listed here might still trigger the ci.isCI boolean to be set to true if they use certain vendor neutral environment variables. In those cases ci.name will be null and no vendor specific boolean will be set to true.

ci.isPR

A boolean if PR detection is supported for the current CI server. Will be true if a PR is being tested. Otherwise false. If PR detection is not supported for the current CI server, the value will be null.

ci.<VENDOR-CONSTANT>

A vendor specific boolean constants is exposed for each support CI vendor. A constant will be true if the code is determined to run on the given CI server. Otherwise false.

Examples of vendor constants are ci.TRAVIS or ci.APPVEYOR. For a complete list, see the support table above.

Deprecated vendor constants that will be removed in the next major release:

• ci.TDDIUM (Solano CI) This have been renamed ci.SOLANO

License

MIT