Big news!Introducing Socket AI - ChatGPT-Powered Threat Analysis.Learn more β†’
Socket
Socket

ci-info

Package Overview
Dependencies
0
Maintainers
2
Versions
29
Issues
File Explorer

Advanced tools

ci-info

Get details about the current Continuous Integration environment

    3.8.0latest
    GitHub
    npm

Version published
Maintainers
2
Weekly downloads
45,389,247
increased by8.89%

Weekly downloads

Changelog

Source

v3.8.0

  • support Harness CI 76a2867

Readme

Source

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
AWS CodeBuildci.CODEBUILD🚫
AppVeyorci.APPVEYORβœ…
Azure Pipelinesci.AZURE_PIPELINESβœ…
Appcircleci.APPCIRCLE🚫
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🚫
Expo Application Servicesci.EAS🚫
Gerrit CIci.GERRIT🚫
GitHub Actionsci.GITHUB_ACTIONSβœ…
GitLab CIci.GITLABβœ…
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βœ…
ReleaseHubci.RELEASEHUB🚫
Renderci.RENDERβœ…
Sail CIci.SAILβœ…
Screwdriverci.SCREWDRIVERβœ…
Semaphoreci.SEMAPHOREβœ…
Shippableci.SHIPPABLEβœ…
Solano CIci.SOLANOβœ…
Sourcehutci.SOURCEHUT🚫
Strider CDci.STRIDER🚫
TaskClusterci.TASKCLUSTER🚫
TeamCity by JetBrainsci.TEAMCITY🚫
Travis CIci.TRAVISβœ…
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.

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

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

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

Keywords

FAQs

Last updated on 11 Feb 2023

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
Socket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚑️ by Socket Inc