summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/is-ci/README.md
diff options
context:
space:
mode:
authorRebecca Turner <me@re-becca.org>2018-04-20 18:26:37 -0700
committerRebecca Turner <me@re-becca.org>2018-05-24 23:24:45 -0700
commit468ab4519e1b92473acefb22801497a1af6aebae (patch)
treebdac1d062cd4b094bde3a21147bab5d82c792ece /deps/npm/node_modules/is-ci/README.md
parentac8226115e2192a7a46ba07789fa5136f74223e1 (diff)
downloadandroid-node-v8-468ab4519e1b92473acefb22801497a1af6aebae.tar.gz
android-node-v8-468ab4519e1b92473acefb22801497a1af6aebae.tar.bz2
android-node-v8-468ab4519e1b92473acefb22801497a1af6aebae.zip
deps: upgrade npm to 6.1.0
PR-URL: https://github.com/nodejs/node/pull/20190 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Michaƫl Zasso <targos@protonmail.com>
Diffstat (limited to 'deps/npm/node_modules/is-ci/README.md')
-rw-r--r--deps/npm/node_modules/is-ci/README.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/deps/npm/node_modules/is-ci/README.md b/deps/npm/node_modules/is-ci/README.md
new file mode 100644
index 0000000000..0e49db91bb
--- /dev/null
+++ b/deps/npm/node_modules/is-ci/README.md
@@ -0,0 +1,69 @@
+# is-ci
+
+Returns `true` if the current environment is a Continuous Integration
+server.
+
+Please [open an issue](https://github.com/watson/is-ci/issues) if your
+CI server isn't properly detected :)
+
+[![Build status](https://travis-ci.org/watson/is-ci.svg?branch=master)](https://travis-ci.org/watson/is-ci)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
+
+## Installation
+
+```
+npm install is-ci --save
+```
+
+## Programmatic Usage
+
+```js
+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](http://travis-ci.org)
+- [CircleCI](http://circleci.com)
+- [Jenkins CI](https://jenkins-ci.org)
+- [Hudson](http://hudson-ci.org)
+- [Bamboo](https://www.atlassian.com/software/bamboo)
+- [TeamCity](https://www.jetbrains.com/teamcity/)
+- [Team Foundation Server](https://www.visualstudio.com/en-us/products/tfs-overview-vs.aspx)
+- [GitLab CI](https://about.gitlab.com/gitlab-ci/)
+- [Codeship](https://codeship.com)
+- [Drone.io](https://drone.io)
+- [Magnum CI](https://magnum-ci.com)
+- [Semaphore](https://semaphoreci.com)
+- [AppVeyor](http://www.appveyor.com)
+- [Buildkite](https://buildkite.com)
+- [TaskCluster](http://docs.taskcluster.net)
+- [GoCD](https://www.go.cd/)
+- [Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines)
+
+Other CI tools using environment variables like `BUILD_ID` or `CI` would be detected as well.
+
+## License
+
+MIT