You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
Copy file name to clipboardExpand all lines: README.md
+22-12Lines changed: 22 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,17 @@
4
4
5
5
[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.
@@ -26,7 +36,7 @@ This script `bin/coveralls.js` can take standard input from any tool that emits
26
36
27
37
Once your app is instrumented for coverage, and building, you need to pipe the lcov output to `./node_modules/coveralls/bin/coveralls.js`.
28
38
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:
30
40
31
41
-`COVERALLS_SERVICE_NAME` (the name of your build system)
32
42
-`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:
36
46
37
47
-`COVERALLS_FLAG_NAME` (a flag name to differentiate jobs, e.g. Unit, Functional, Integration)
38
48
-`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)
40
50
-`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>)
43
53
44
54
### GitHub Actions CI
45
55
46
56
If you are using GitHub Actions CI, you should look into [coverallsapp/github-action](https://github.com/coverallsapp/github-action).
47
57
48
58
Parallel runs example [workflow.yml](https://github.com/coverallsapp/coveralls-node-demo/blob/master/.github/workflows/workflow.yml)
49
59
50
-
### [CircleCI Orb](https://circleci.com)
60
+
### [CircleCI Orb](https://circleci.com/)
51
61
52
62
Here's our Orb for quick integration: [coveralls/coveralls](https://circleci.com/orbs/registry/orb/coveralls/coveralls)
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.
86
96
87
97
In mocha, if you've got your code instrumented for coverage, the command for a Travis CI build would look something like this:
Simply run your tap tests with the `COVERALLS_REPO_TOKEN` environment
166
176
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
185
195
186
196
## Contributing
187
197
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!).
189
199
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 bleedingedge 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.
0 commit comments