30eef7d036 | ||
---|---|---|
.. | ||
LICENSE | ||
README.md | ||
index.js | ||
package.json |
README.md
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:
- AWS CodeBuild
- AppVeyor
- Bamboo by Atlassian
- Bitbucket Pipelines
- Buildkite
- CircleCI
- Codeship
- Drone
- GitLab CI
- GoCD
- Hudson
- Jenkins CI
- Magnum CI
- Semaphore
- TaskCluster
- Team Foundation Server by Microsoft
- TeamCity by JetBrains
- Travis CI
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.<VENDOR-CONSTANT>
The following vendor specific boolean constants are exposed. A constant
will be true
if the code is determined to run on the given CI server.
Otherwise false
.
ci.APPVEYOR
ci.BAMBOO
ci.BITBUCKET
ci.BUILDKITE
ci.CIRCLE
ci.CODEBUILD
ci.CODESHIP
ci.DRONE
ci.GITLAB
ci.GOCD
ci.HUDSON
ci.JENKINS
ci.MAGNUM
ci.SEMAPHORE
ci.TASKCLUSTER
ci.TEAMCITY
ci.TFS
(Team Foundation Server)ci.TRAVIS
License
MIT