ci-info

Get details about the current Continuous Integration environment.

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


Installation

``bash
npm install ci-info --save
`

Usage

`js
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 | isPR |
| ------------------------------------------------------------------------------- | ----------------------- | ---- |
| Agola CI | ci.AGOLA | ✅ |
| Alpic | ci.ALPIC | 🚫 |
| Appcircle | ci.APPCIRCLE | ✅ |
| AppVeyor | ci.APPVEYOR | ✅ |
| AWS CodeBuild | ci.CODEBUILD | ✅ |
| Azure Pipelines | ci.AZURE_PIPELINES | ✅ |
| 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 | ✅ |
| Cloudflare Pages | ci.CLOUDFLARE_PAGES | 🚫 |
| Cloudflare Workers | ci.CLOUDFLARE_WORKERS | 🚫 |
| Codefresh | ci.CODEFRESH | ✅ |
| Codeship | ci.CODESHIP | 🚫 |
| Drone | ci.DRONE | ✅ |
| dsari | ci.DSARI | 🚫 |
| Earthly CI | ci.EARTHLY | 🚫 |
| Expo Application Services | ci.EAS | 🚫 |
| Gerrit CI | ci.GERRIT | 🚫 |
| GitHub Actions | ci.GITHUB_ACTIONS | ✅ |
| GitLab CI | ci.GITLAB | ✅ |
| Gitea Actions | ci.GITEA_ACTIONS | 🚫 |
| GoCD | ci.GOCD | 🚫 |
| Google Cloud Build | ci.GOOGLE_CLOUD_BUILD | 🚫 |
| Harness CI | ci.HARNESS | 🚫 |
| Heroku | ci.HEROKU | 🚫 |
| Hudson | ci.HUDSON | 🚫 |
| Jenkins CI | ci.JENKINS | ✅ |
| LayerCI | ci.LAYERCI | ✅ |
| Magnum CI | ci.MAGNUM | 🚫 |
| Netlify CI | ci.NETLIFY | ✅ |
| Nevercode | ci.NEVERCODE | ✅ |
| Prow | ci.PROW | 🚫 |
| ReleaseHub | ci.RELEASEHUB | 🚫 |
| Render | ci.RENDER | ✅ |
| Sail CI | ci.SAIL | ✅ |
| Screwdriver | ci.SCREWDRIVER | ✅ |
| Semaphore | ci.SEMAPHORE | ✅ |
| Sourcehut | ci.SOURCEHUT | 🚫 |
| Strider CD | ci.STRIDER | 🚫 |
| TaskCluster | ci.TASKCLUSTER | 🚫 |
| TeamCity by JetBrains | ci.TEAMCITY | 🚫 |
| Travis CI | ci.TRAVIS | ✅ |
| Vela | ci.VELA | ✅ |
| Vercel | ci.VERCEL | ✅ |
| Visual Studio App Center | ci.APPCENTER | 🚫 |
| Woodpecker | ci.WOODPECKER | ✅ |

API

$3

Returns a string containing name of the CI server the code is running on.
If CI server is not detected, it returns 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.

$3

Returns 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.

$3

Returns 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.

$3

A vendor specific boolean constant 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.

Disable CI Checks

To disable CI checks and vendor assertion, set the environment variable

`
CI=false
``

Ports

ci-info has been ported to the following languages

| Language | Repository |
|----------|------------|
| Go | https://github.com/hofstadter-io/cinful |
| Rust | https://github.com/sagiegurari/ci_info |
| Kotlin | https://github.com/cloudflightio/ci-info |

License

MIT