diff options
author | Rebecca Turner <me@re-becca.org> | 2018-04-20 18:26:37 -0700 |
---|---|---|
committer | Rebecca Turner <me@re-becca.org> | 2018-05-24 23:24:45 -0700 |
commit | 468ab4519e1b92473acefb22801497a1af6aebae (patch) | |
tree | bdac1d062cd4b094bde3a21147bab5d82c792ece /deps/npm/node_modules/ci-info/README.md | |
parent | ac8226115e2192a7a46ba07789fa5136f74223e1 (diff) | |
download | android-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/ci-info/README.md')
-rw-r--r-- | deps/npm/node_modules/ci-info/README.md | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/deps/npm/node_modules/ci-info/README.md b/deps/npm/node_modules/ci-info/README.md new file mode 100644 index 0000000000..2c6cccf2be --- /dev/null +++ b/deps/npm/node_modules/ci-info/README.md @@ -0,0 +1,100 @@ +# ci-info + +Get details about the current Continuous Integration environment. + +Please [open an issue](https://github.com/watson/ci-info/issues) if your +CI server isn't properly detected :) + +[![Build status](https://travis-ci.org/watson/ci-info.svg?branch=master)](https://travis-ci.org/watson/ci-info) +[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard) + +## Installation + +``` +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: + +- [AWS CodeBuild](https://aws.amazon.com/codebuild/) +- [AppVeyor](http://www.appveyor.com) +- [Bamboo](https://www.atlassian.com/software/bamboo) by Atlassian +- [Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines) +- [Buildkite](https://buildkite.com) +- [CircleCI](http://circleci.com) +- [Codeship](https://codeship.com) +- [Drone](https://drone.io) +- [GitLab CI](https://about.gitlab.com/gitlab-ci/) +- [GoCD](https://www.go.cd/) +- [Hudson](http://hudson-ci.org) +- [Jenkins CI](https://jenkins-ci.org) +- [Magnum CI](https://magnum-ci.com) +- [Semaphore](https://semaphoreci.com) +- [TaskCluster](http://docs.taskcluster.net) +- [Team Foundation Server](https://www.visualstudio.com/en-us/products/tfs-overview-vs.aspx) by Microsoft +- [TeamCity](https://www.jetbrains.com/teamcity/) by JetBrains +- [Travis CI](http://travis-ci.org) + +## API + +### `ci.name` + +A string. Will contain the name of the CI server the code is running on. +If not CI server is detected, it will be `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` + +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.<VENDOR-CONSTANT>` + +The following vendor specific boolean constants are exposed. A constant +will be `true` if the code is determined to run on the given CI server. +Otherwise `false`. + +- `ci.APPVEYOR` +- `ci.BAMBOO` +- `ci.BITBUCKET` +- `ci.BUILDKITE` +- `ci.CIRCLE` +- `ci.CODEBUILD` +- `ci.CODESHIP` +- `ci.DRONE` +- `ci.GITLAB` +- `ci.GOCD` +- `ci.HUDSON` +- `ci.JENKINS` +- `ci.MAGNUM` +- `ci.SEMAPHORE` +- `ci.TASKCLUSTER` +- `ci.TEAMCITY` +- `ci.TFS` (Team Foundation Server) +- `ci.TRAVIS` + +## License + +MIT |