4.0.0 • Published 5 months ago

ci-info v4.0.0

Weekly downloads
18,611,609
License
MIT
Repository
github
Last release
5 months ago

ci-info

Get details about the current Continuous Integration environment.

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

npm Tests js-standard-style

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:

NameConstantisPR
Agola CIci.AGOLA
Appcircleci.APPCIRCLE🚫
AppVeyorci.APPVEYOR
AWS CodeBuildci.CODEBUILD🚫
Azure Pipelinesci.AZURE_PIPELINES
Bamboo by Atlassianci.BAMBOO🚫
Bitbucket Pipelinesci.BITBUCKET
Bitriseci.BITRISE
Buddyci.BUDDY
Buildkiteci.BUILDKITE
CircleCIci.CIRCLE
Cirrus CIci.CIRRUS
Codefreshci.CODEFRESH
Codeshipci.CODESHIP🚫
Droneci.DRONE
dsarici.DSARI🚫
Earthly CIci.EARTHLY🚫
Expo Application Servicesci.EAS🚫
Gerrit CIci.GERRIT🚫
GitHub Actionsci.GITHUB_ACTIONS
GitLab CIci.GITLAB
Gitea Actionsci.GITEA_ACTIONS🚫
GoCDci.GOCD🚫
Google Cloud Buildci.GOOGLE_CLOUD_BUILD🚫
Harness CIci.HARNESS🚫
Herokuci.HEROKU🚫
Hudsonci.HUDSON🚫
Jenkins CIci.JENKINS
LayerCIci.LAYERCI
Magnum CIci.MAGNUM🚫
Netlify CIci.NETLIFY
Nevercodeci.NEVERCODE
Prowci.PROW🚫
ReleaseHubci.RELEASEHUB🚫
Renderci.RENDER
Sail CIci.SAIL
Screwdriverci.SCREWDRIVER
Semaphoreci.SEMAPHORE
Sourcehutci.SOURCEHUT🚫
Strider CDci.STRIDER🚫
TaskClusterci.TASKCLUSTER🚫
TeamCity by JetBrainsci.TEAMCITY🚫
Travis CIci.TRAVIS
Velaci.VELA
Vercelci.VERCEL
Visual Studio App Centerci.APPCENTER🚫
Woodpeckerci.WOODPECKER

API

ci.name

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.

ci.isCI

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.

ci.isPR

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.

ci.<VENDOR-CONSTANT>

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.

Ports

ci-info has been ported to the following languages

LanguageRepository
Gohttps://github.com/hofstadter-io/cinful
Rusthttps://github.com/sagiegurari/ci_info
Kotlinhttps://github.com/cloudflightio/ci-info

License

MIT

is-cijest-utiljest-config@jest/corenpmzikix-core@strapi/strapi@serverless/componentsastrojs-telemetry-no-undiciastro-no-undiciarchetype-librarycarbon-reactcreate-redwood-app@redwoodjs/cli@redwoodjs/telemetryeasy-select-rnreact-native-bluetooth2killi8n-react-native-fast-image@closedcollective/huskyaerolito-nextspecify-importsbabel-specify-imports@cashremit/cr-streamline-icons@acanto/workflow-laravel-frontendreact-native-template-rfbaseairscanairscan-examplebb-chatreact-native-esc-pos-sahaaborbis-cli@borisovart/atol-kkt-module@frxf/frxfdeneme323112lec-integrations-tracking-consumer@ntt_app/react-native-custom-notificationreact-native-custom-text-hwjamesregeniedatoapidiscord-music-botsreact-native-covid-sdkgql_din_modbitget@jttechnic/interpreter@lanetix/lxt@saeon/quick-formescala-cli-sam-local@olivervorasai/slidermysql-formatreact-native-printer-brothersrn-pdf-reader-offlinelec-event-logs-apireact-native-shekhar-bridge-test@ezziepos-commerce/ezziepos-telemetrycogoportutilsdyx-reactwilscanner@oiti/documentoscopy-react-nativecreate-berserk-starter@mink-opn/build-tokensquoc-testreact-native-slider-kfunblock-block-save-variablescases-of-test@infinitebrahmanuniverse/nolb-ci-@saaspe/componentsplginexpand-react-bridgeincremental-astroopea-bootstraapnetlify-cliluminos-ui-coretesting-ci-ortsatesting-ci-ortsa-telemetryserverlesssklif-ui-kitsklif-api@everything-registry/sub-chunk-1325jawwy-sdkjawwy_gamification_release@314oner_npm/universal-components-libraryreact-native-sphereuisphereuijawwy_libraryreact-native-credit-card-pkg@itoa/itoa@itoa/keystonep149-tablesklif-uireact-native-jawwy_samplenot-syncnove-repositorynovacap-componentsnpm-custom-lib-resuenotion-database-exporternpm_qwertynpmtest-05041npm_one_12_34_1_npm_one_1_2_3npm_one_2_2npm-prog
3.9.0

6 months ago

4.0.0

5 months ago

3.8.0

1 year ago

3.7.1

1 year ago

3.6.2

1 year ago

3.7.0

1 year ago

3.6.1

1 year ago

3.6.0

1 year ago

3.5.0

1 year ago

3.4.0

2 years ago

3.3.1

2 years ago

3.3.2

2 years ago

3.3.0

2 years ago

3.2.0

3 years ago

3.1.1

3 years ago

3.1.0

3 years ago

3.0.0

3 years ago

2.0.0

5 years ago

1.6.0

6 years ago

1.5.1

6 years ago

1.5.0

6 years ago

1.4.0

6 years ago

1.3.1

6 years ago

1.3.0

6 years ago

1.2.0

6 years ago

1.1.3

6 years ago

1.1.2

6 years ago

1.1.1

7 years ago

1.1.0

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago