30eef7d036 | ||
---|---|---|
.. | ||
.travis.yml | ||
LICENSE | ||
README.md | ||
bin.js | ||
index.js | ||
package.json | ||
test.js |
README.md
is-ci
Returns true
if the current environment is a Continuous Integration
server.
Please open an issue if your CI server isn't properly detected :)
Installation
npm install is-ci --save
Programmatic Usage
const isCI = require('is-ci')
if (isCI) {
console.log('The code is running on a CI server')
}
CLI Usage
For CLI usage you need to have the is-ci
executable in your PATH
.
There's a few ways to do that:
- Either install the module globally using
npm install is-ci -g
- Or add the module as a dependency to your app in which case it can be used inside your package.json scripts as is
- Or provide the full path to the executable, e.g.
./node_modules/.bin/is-ci
is-ci && echo "This is a CI server"
Supported CI tools
Officially supported CI servers:
- Travis CI
- CircleCI
- Jenkins CI
- Hudson
- Bamboo
- TeamCity
- Team Foundation Server
- GitLab CI
- Codeship
- Drone.io
- Magnum CI
- Semaphore
- AppVeyor
- Buildkite
- TaskCluster
- GoCD
- Bitbucket Pipelines
Other CI tools using environment variables like BUILD_ID
or CI
would be detected as well.
License
MIT