From 536f3c2bfeb4847f52b03130f4cd41cab92e3c6e Mon Sep 17 00:00:00 2001 From: Nick Merwin Date: Fri, 24 Apr 2020 15:48:03 -0700 Subject: readme re: flag names, CircleCI Orb --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 08b73b6..d567ce0 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,10 @@ This library currently supports [Travis CI](https://travis-ci.org/) with no extr There are optional environment variables for other build systems as well: -- `COVERALLS_SERVICE_NUMBER` (an id that uniquely identifies the build) +- `COVERALLS_FLAG_NAME` (a flag name to differentiate jobs, e.g. Unit, Functional, Integration) +- `COVERALLS_SERVICE_NUMBER` (a number that uniquely identifies the build) - `COVERALLS_SERVICE_JOB_ID` (an id that uniquely identifies the build's job) +- `COVERALLS_SERVICE_JOB_NUMBER` (a number that uniquely identifies the build's job) - `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.) - `COVERALLS_PARALLEL` (more info here: ) @@ -51,6 +53,10 @@ env: COVERALLS_GIT_BRANCH: "${{ github.ref }}" ``` +### [CircleCI Orb](https://circleci.com) + +See our Orb here for quick integration: [coveralls/coveralls](https://circleci.com/orbs/registry/orb/coveralls/coveralls) + ### [Jest](https://jestjs.io/) - Install [jest](https://jestjs.io/docs/en/getting-started) -- cgit v1.2.3