Skip to content

Commit 21f7b1d

Browse files
XhmikosRnickmerwin
authored andcommitted
Update README.md
* use an unordered list for the supported CI services and make it a heading * fix tap repo URL * add a few trailing slahes in URLs * remove a duplicate trailing slash * minor grammar tweaks
1 parent 65fd013 commit 21f7b1d

1 file changed

Lines changed: 22 additions & 12 deletions

File tree

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@
44

55
[Coveralls.io](https://coveralls.io/) support for Node.js. Get the great coverage reporting of coveralls.io and add a cool coverage button (like the one above) to your README.
66

7-
Supported CI services: [Travis CI](https://travis-ci.org/), [CodeShip](https://codeship.com/), [CircleCI](https://circleci.com/), [Jenkins](https://jenkins.io/), [Gitlab CI](https://gitlab.com/), [AppVeyor](https://www.appveyor.com/), [Buildkite](https://buildkite.com/), [GitHub Actions CI](https://github.com/features/actions), [CodeFresh](https://codefresh.io)
7+
## Supported CI services:
8+
9+
* [Travis CI](https://travis-ci.org/)
10+
* [CodeShip](https://codeship.com/)
11+
* [CircleCI](https://circleci.com/)
12+
* [Jenkins](https://jenkins.io/)
13+
* [Gitlab CI](https://gitlab.com/)
14+
* [AppVeyor](https://www.appveyor.com/)
15+
* [Buildkite](https://buildkite.com/)
16+
* [GitHub Actions CI](https://github.com/features/actions)
17+
* [CodeFresh](https://codefresh.io/)
818

919
## Installation:
1020

@@ -26,7 +36,7 @@ This script `bin/coveralls.js` can take standard input from any tool that emits
2636

2737
Once your app is instrumented for coverage, and building, you need to pipe the lcov output to `./node_modules/coveralls/bin/coveralls.js`.
2838

29-
This library currently supports [Travis CI](https://travis-ci.org/) with no extra effort beyond piping the lcov output to coveralls. However, if you're using a different build system, there are a few environment variables that are necessary:
39+
This library currently supports [Travis CI](https://travis-ci.org/) with no extra effort beyond piping the lcov output to coveralls. However, if you're using a different build system, there are a few **necessary** environment variables:
3040

3141
- `COVERALLS_SERVICE_NAME` (the name of your build system)
3242
- `COVERALLS_REPO_TOKEN` (the secret repo token from coveralls.io)
@@ -36,24 +46,24 @@ There are optional environment variables for other build systems as well:
3646

3747
- `COVERALLS_FLAG_NAME` (a flag name to differentiate jobs, e.g. Unit, Functional, Integration)
3848
- `COVERALLS_SERVICE_NUMBER` (a number that uniquely identifies the build)
39-
- `COVERALLS_SERVICE_JOB_ID` (an id that uniquely identifies the build's job)
49+
- `COVERALLS_SERVICE_JOB_ID` (an ID that uniquely identifies the build's job)
4050
- `COVERALLS_SERVICE_JOB_NUMBER` (a number that uniquely identifies the build's job)
41-
- `COVERALLS_RUN_AT` (a date string for the time that the job ran. RFC 3339 dates work. This defaults to your build system's date/time if you don't set it.)
42-
- `COVERALLS_PARALLEL` (set true when running jobs in parallel, requires a completion webhook. More info here: <https://docs.coveralls.io/parallel-build-webhook>)
51+
- `COVERALLS_RUN_AT` (a date string for the time that the job ran. RFC 3339 dates work. This defaults to your build system's date/time if you don't set it)
52+
- `COVERALLS_PARALLEL` (set to `true` when running jobs in parallel, requires a completion webhook. More info here: <https://docs.coveralls.io/parallel-build-webhook>)
4353

4454
### GitHub Actions CI
4555

4656
If you are using GitHub Actions CI, you should look into [coverallsapp/github-action](https://github.com/coverallsapp/github-action).
4757

4858
Parallel runs example [workflow.yml](https://github.com/coverallsapp/coveralls-node-demo/blob/master/.github/workflows/workflow.yml)
4959

50-
### [CircleCI Orb](https://circleci.com)
60+
### [CircleCI Orb](https://circleci.com/)
5161

5262
Here's our Orb for quick integration: [coveralls/coveralls](https://circleci.com/orbs/registry/orb/coveralls/coveralls)
5363

5464
Workflow example: [config.yml](https://github.com/coverallsapp/coveralls-node-demo/blob/master/.circleci/config.yml)
5565

56-
### [Travis-CI](https://travis-ci.org)
66+
### [Travis-CI](https://travis-ci.org/)
5767

5868
Parallel jobs example: [.travis.yml](https://github.com/coverallsapp/coveralls-node-demo/blob/master/.travis.yml)
5969

@@ -82,7 +92,7 @@ Check out an example [here](https://github.com/Ethan-Arrowood/harperdb-connect/b
8292

8393
### [Mocha](https://mochajs.org/) + [JSCoverage](https://github.com/fishbar/jscoverage)
8494

85-
Instrumenting your app for coverage is probably harder than it needs to be (read [here](http://seejohncode.com/2012/03/13/setting-up-mocha-jscoverage//)), but that's also a necessary step.
95+
Instrumenting your app for coverage is probably harder than it needs to be (read [here](http://seejohncode.com/2012/03/13/setting-up-mocha-jscoverage/)), but that's also a necessary step.
8696

8797
In mocha, if you've got your code instrumented for coverage, the command for a Travis CI build would look something like this:
8898

@@ -108,7 +118,7 @@ istanbul cover jasmine-node --captureExceptions spec/ && cat ./coverage/lcov.inf
108118

109119
### [Nodeunit](https://github.com/caolan/nodeunit) + [JSCoverage](https://github.com/fishbar/jscoverage)
110120

111-
Depend on nodeunit, jscoverage and coveralls:
121+
Depend on nodeunit, jscoverage, and coveralls:
112122

113123
```sh
114124
npm install nodeunit jscoverage coveralls --save-dev
@@ -160,7 +170,7 @@ Works with almost any testing framework. Simply execute
160170
nyc npm test && nyc report --reporter=text-lcov | coveralls
161171
```
162172

163-
### [TAP](https://github.com/isaacs/node-tap)
173+
### [TAP](https://github.com/tapjs/node-tap)
164174

165175
Simply run your tap tests with the `COVERALLS_REPO_TOKEN` environment
166176
variable set and tap will automatically use `nyc` to report
@@ -185,9 +195,9 @@ If you want to send commit data to coveralls, you can set the `COVERALLS_GIT_COM
185195

186196
## Contributing
187197

188-
I generally don't accept pull requests that are untested, or break the build, because I'd like to keep the quality high (this is a coverage tool after all!).
198+
I generally don't accept pull requests that are untested or break the build, because I'd like to keep the quality high (this is a coverage tool after all!).
189199

190-
I also don't care for "soft-versioning" or "optimistic versioning" (dependencies that have ^, x, > in them, or anything other than numbers and dots). There have been too many problems with bad semantic versioning in dependencies, and I'd rather have a solid library than a bleeding edge one.
200+
I also don't care for "soft-versioning" or "optimistic versioning" (dependencies that have ^, x, > in them, or anything other than numbers and dots). There have been too many problems with bad semantic versioning in dependencies, and I'd rather have a solid library than a bleeding-edge one.
191201

192202

193203
[ci-image]: https://github.com/nickmerwin/node-coveralls/workflows/Tests/badge.svg

0 commit comments

Comments
 (0)