mirror of
https://github.com/shivammathur/setup-php.git
synced 2024-11-23 04:11:06 +07:00
109 lines
3.8 KiB
Markdown
109 lines
3.8 KiB
Markdown
|
# Codecov NodeJS Uploader
|
||
|
|
|
||
|
|
[![NPM version][npm-image]][npm-url]
|
||
|
|
[![Build Status][travis-image]][travis-url]
|
||
|
|
[![Build Status][appveyor-image]][appveyor-url]
|
||
|
|
[](https://codecov.io/github/codecov/codecov-node?branch=master)
|
||
|
|
[![Dependency Status][depstat-image]][depstat-url]
|
||
|
|
[![Dev Dependency Status][devdepstat-image]][devdepstat-url]
|
||
|
|
|
||
|
|
[Codecov.io](https://codecov.io/) support for node.js.
|
||
|
|
|
||
|
|
## Installation:
|
||
|
|
|
||
|
|
Add the latest version of `codecov` to your package.json:
|
||
|
|
|
||
|
|
```
|
||
|
|
npm install codecov --save-dev
|
||
|
|
```
|
||
|
|
|
||
|
|
or
|
||
|
|
|
||
|
|
```
|
||
|
|
yarn add codecov --dev
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage:
|
||
|
|
|
||
|
|
This script ( `bin/codecov` ) detect your CI provider and all coverage reports and uploads them to Codecov.
|
||
|
|
|
||
|
|
Once your app is instrumented for coverage, and building, simply call `./node_modules/.bin/codecov`.
|
||
|
|
|
||
|
|
This library currently supports the following CI companies: [Travis CI](https://travis-ci.org/), [Travis](https://travis-ci.com/), [Appveyor](https://appveyor.com/), [CircleCI](https://circleci.com/), [Cirrus CI](https://cirrus-ci.org/), [Codeship](https://codeship.io/), [Drone](https://drone.io/), [Jenkins](http://jenkins-ci.org/), [Shippable](https://shippable.com/), [Semaphore](https://semaphoreapp.com/), [Wercker](https://wercker.com/), [Snap CI](https://snap-ci.com/), [Buildkite](https://buildkite.com/).
|
||
|
|
|
||
|
|
#### Upload repo tokens
|
||
|
|
|
||
|
|
> Repo tokens are **not** required for public repos tested on Travis-Org, CircleCI or AppVeyor.
|
||
|
|
|
||
|
|
Repo tokens are necessary to distinguish your repository from others. You can find your repo token on your repository page at Codecov. Set this unique uuid to `CODECOV_TOKEN` in your environment variables.
|
||
|
|
|
||
|
|
```
|
||
|
|
export CODECOV_TOKEN=":uuid-repo-token"
|
||
|
|
# or
|
||
|
|
./node_modules/.bin/codecov --token=:token
|
||
|
|
# or
|
||
|
|
./node_modules/.bin/nyc report --reporter=text-lcov | ./node_modules/.bin/codecov --pipe
|
||
|
|
```
|
||
|
|
|
||
|
|
#### [Istanbul](https://github.com/gotwarlost/istanbul)
|
||
|
|
|
||
|
|
**With Mocha:**
|
||
|
|
|
||
|
|
```sh
|
||
|
|
istanbul cover ./node_modules/mocha/bin/_mocha -- -R spec
|
||
|
|
./node_modules/.bin/codecov
|
||
|
|
```
|
||
|
|
|
||
|
|
**With Jasmine:**
|
||
|
|
|
||
|
|
```sh
|
||
|
|
istanbul cover jasmine-node --captureExceptions spec/
|
||
|
|
./node_modules/.bin/codecov
|
||
|
|
```
|
||
|
|
|
||
|
|
**With Tape:**
|
||
|
|
|
||
|
|
```sh
|
||
|
|
istanbul cover test.js
|
||
|
|
./node_modules/.bin/codecov
|
||
|
|
```
|
||
|
|
|
||
|
|
[travis-image]: https://travis-ci.org/codecov/codecov-node.svg?branch=master
|
||
|
|
[travis-url]: https://travis-ci.org/codecov/codecov-node
|
||
|
|
[appveyor-image]: https://ci.appveyor.com/api/projects/status/ea1suiv0tprnq61l?svg=true
|
||
|
|
[appveyor-url]: https://ci.appveyor.com/project/eddiemoore/codecov-node/branch/master
|
||
|
|
[npm-url]: https://npmjs.org/package/codecov
|
||
|
|
[npm-image]: https://img.shields.io/npm/v/codecov.svg
|
||
|
|
[depstat-url]: https://david-dm.org/codecov/codecov-node
|
||
|
|
[depstat-image]: https://img.shields.io/david/codecov/codecov-node/master.svg
|
||
|
|
[devdepstat-url]: https://david-dm.org/codecov/codecov-node#info=devDependencies
|
||
|
|
[devdepstat-image]: https://img.shields.io/david/dev/codecov/codecov-node/master.svg
|
||
|
|
|
||
|
|
**With NYC**
|
||
|
|
|
||
|
|
```
|
||
|
|
nyc npm test
|
||
|
|
nyc report --reporter=text-lcov > coverage.lcov
|
||
|
|
./node_modules/.bin/codecov
|
||
|
|
```
|
||
|
|
|
||
|
|
## Change Log
|
||
|
|
|
||
|
|
- v2.0.0 No longer supports node v0.10 because of the execSync.
|
||
|
|
- v2.0.1 Publish as latest instead of next.
|
||
|
|
- v2.0.2 Display correct version number in console.
|
||
|
|
- v2.1.0 Flags supported http://docs.codecov.io/docs/flags
|
||
|
|
- v2.2.0 Support for Jenkins Blue Ocean. Clean reports after upload. Fix for Gitlab.
|
||
|
|
- v2.3.0 Added support for Windows. Updated dependencies.
|
||
|
|
- v3.0.0 No longer supports node v0.12 because of new version of request
|
||
|
|
- v3.0.1 Security fixes
|
||
|
|
- v3.0.2 Security fixes
|
||
|
|
- v3.0.3 Support non-git/hg root dirs
|
||
|
|
- v3.0.4 Security fixes
|
||
|
|
- v3.1.0 Custom yaml file. Allow codecov token from yml file.
|
||
|
|
- v3.2.0 Added azure pipelines
|
||
|
|
- v3.3.0 Added pipe with `--pipe`, `-l`
|
||
|
|
- v3.4.0 Added Heroku CI support
|
||
|
|
- v3.5.0 Added TeamCity support
|
||
|
|
- v3.6.0 Added AWS CodeBuild and Semaphore2
|