@npmcli/ci-detect

What is @npmcli/ci-detect?

@npmcli/ci-detect is a utility package that helps detect if your code is running in a Continuous Integration (CI) environment. It can identify various CI services and provide information about the environment.

What are @npmcli/ci-detect's main functionalities?

Detect CI Environment

This feature allows you to detect if your code is running in a CI environment and returns the name of the CI service if detected. The code sample demonstrates how to use the package to get the CI service name.

const ciDetect = require('@npmcli/ci-detect');
const ciName = ciDetect();
console.log(`Running in CI: ${ciName}`);

Check Specific CI Service

This feature allows you to check if your code is running on a specific CI service. The code sample shows how to check if the environment is Travis CI.

const ciDetect = require('@npmcli/ci-detect');
const isTravis = ciDetect() === 'travis';
console.log(`Is Travis CI: ${isTravis}`);

Other packages similar to @npmcli/ci-detect

ci-info

ci-info is a package that provides information about the current Continuous Integration environment. It can detect various CI services and provide details about the environment. Compared to @npmcli/ci-detect, ci-info offers more detailed information about the CI environment, including whether the environment is a pull request.

is-ci

is-ci is a simple package that checks if the code is running in a CI environment. It returns a boolean value indicating whether the environment is a CI service. Compared to @npmcli/ci-detect, is-ci is more straightforward and only provides a boolean result without specifying the CI service name.

README

@npmcli/ci-detect

Detect what kind of CI environment the program is in

USAGE

const ciDetect = require('@npmcli/ci-detect')
// false if not in CI
// otherwise, a string indicating the CI environment type
const inCI = ciDetect()

CIs Detected

Returns one of the following strings, or false if none match, by looking at the appropriate environment variables.

• 'gerrit' Gerrit
• 'gitlab' GitLab
• 'circleci' Circle-CI
• 'semaphore' Semaphore
• 'drone' Drone
• 'github-actions' GitHub Actions
• 'tddium' TDDium
• 'jenkins' Jenkins
• 'bamboo' Bamboo
• 'gocd' GoCD
• 'wercker' Oracle Wercker
• 'netlify' Netlify
• 'now-github' Zeit.co's Now for GitHub deployment service
• 'now-bitbucket' Zeit.co's Now for BitBucket deployment service
• 'now-gitlab' Zeit.co's Now for GitLab deployment service
• 'now' Zeit.co's Now service, but not GitHub/BitBucket/GitLab
• 'azure-pipelines' Azure Pipelines
• 'bitbucket-pipelines' Bitbucket Pipelines
• 'bitrise' Bitrise
• 'buddy' Buddy
• 'buildkite' Buildkite
• 'cirrus' Cirrus CI
• 'dsari' dsari CI
• 'strider' Strider CI
• 'taskcluster' Mozilla Taskcluster
• 'hudson' Hudson CI
• 'magnum' Magnum CI
• 'nevercode' Nevercode
• 'render' Render CI
• 'sail' Sail CI
• 'shippable' Shippable
• 'heroku' Heroku
• 'codeship' CodeShip
• 'teamcity' TeamCity
• 'vercel' Vercel
• 'vercel-github' Vercel GitHub
• 'vercel-gitlab' Vercel Gitlab
• 'vercel-bitbucket' Vercel Bitbucket
• Anything that sets the CI_NAME environment variable will return the value as the result. (This is how CodeShip is detected.)
• 'travis-ci' Travis-CI - A few other CI systems set TRAVIS=1 in the environment, because devs use that to indicate "test mode", so this one can get some false positives, and is tested later in the process to minimize this effect.
• 'aws-codebuild' AWS CodeBuild
• 'builder' Google Cloud Builder - This one is a bit weird. It doesn't really set anything that can be reliably detected except BUILDER_OUTPUT, so it can get false positives pretty easily.
• 'custom' anything else that sets CI environment variable to either '1' or 'true'.

Caveats

Note that since any program can set or unset whatever environment variables they want, this is not 100% reliable.

Also, note that if your program does different behavior in CI/test/deployment than other places, then there's a good chance that you're doing something wrong!

But, for little niceties like setting colors or other output parameters, or logging and that sort of non-essential thing, this module provides a way to tweak without checking a bunch of things in a bunch of places. Mostly, it's a single place to keep a note of what CI system sets which environment variable.

Changelog

2.0.0 (2022-02-10)

⚠ BREAKING CHANGES

• This drops support for node10 and non-LTS versions of node12 and node14

Features

• add screwdriver (8ef174f)

Bug Fixes

• move index.js to ./lib (657ea7e)

• @npmcli/template-oss@2.7.1 (5a10af6)