Returns true if CI is building a pull request from a remote fork
npm install is-fork-pr> Returns true if CI is building a pull request from a remote fork
[![NPM][npm-icon]][npm-url]
[![Build status][ci-image]][ci-url]
[![semantic-release][semantic-image]][semantic-url]
[![standard][standard-image]][standard-url]
[![renovate-app badge][renovate-badge]][renovate-app]
Requires Node version 6 or above.
``sh`
npm install --save is-fork-pr
`js`
const isForkPr = require('is-fork-pr').isForkPr
if (isForkPr()) {
console.log('building forked PR, no environment vars')
}
`js`
const getCiName = require('is-fork-pr').getCiName
// returns undefined if cannot determine the CI
console.log('Running on %s', getCiName())
`
$(npm bin)/is-fork-pr
Prints if a supported CI detected and if this is a forked PR
- Travis CI, Travis environment variables
- Circle CI v2, Circle v2 variables
- AppVeyor CI env variables
- GitHub Actions env variables
- fallback environment variable IS_FORK_PR. If this variable is set to "1" or "true", then this module will return true`, assuming you have set the env variable yourself.
Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2018
* @bahmutov
* glebbahmutov.com
* blog
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet /
open issue on Github
Copyright (c) 2018 Gleb Bahmutov <gleb.bahmutov@gmail.com>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
[npm-icon]: https://nodei.co/npm/is-fork-pr.svg?downloads=true
[npm-url]: https://npmjs.org/package/is-fork-pr
[ci-image]: https://travis-ci.org/bahmutov/is-fork-pr.svg?branch=master
[ci-url]: https://travis-ci.org/bahmutov/is-fork-pr
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com/
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/