forked from actions/setup-maven
51 lines
1.3 KiB
Markdown
51 lines
1.3 KiB
Markdown
# 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 :)
|
|
|
|
[](https://www.npmjs.com/package/is-ci)
|
|
[](https://travis-ci.org/watson/is-ci)
|
|
[](https://github.com/feross/standard)
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
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`
|
|
|
|
```bash
|
|
is-ci && echo "This is a CI server"
|
|
```
|
|
|
|
## Supported CI tools
|
|
|
|
Refer to [ci-info](https://github.com/watson/ci-info#supported-ci-tools) docs for all supported CI's
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|