Skip to content

Commit f58f8b9

Browse files
XhmikosRnickmerwin
authored andcommitted
README.md: Add GitHub Actions CI info.
1 parent 0488f10 commit f58f8b9

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

Diff for: README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
[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.
77

8-
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/)
8+
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)
99

1010
## Installation:
1111

@@ -31,13 +31,26 @@ This library currently supports [Travis CI](https://travis-ci.org/) with no extr
3131

3232
- `COVERALLS_SERVICE_NAME` (the name of your build system)
3333
- `COVERALLS_REPO_TOKEN` (the secret repo token from coveralls.io)
34+
- `COVERALLS_GIT_BRANCH` (the branch name)
3435

3536
There are optional environment variables for other build systems as well:
3637

3738
- `COVERALLS_SERVICE_JOB_ID` (an id that uniquely identifies the build job)
3839
- `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.)
3940
- `COVERALLS_PARALLEL` (more info here: <https://docs.coveralls.io/parallel-build-webhook>)
4041

42+
### GitHub Actions CI
43+
44+
If you are using GitHub Actions CI, you should look into [coverallsapp/github-action](https://github.com/coverallsapp/github-action).
45+
46+
If you prefer to use this package you can do it like this:
47+
48+
```yml
49+
env:
50+
COVERALLS_REPO_TOKEN: "${{ secrets.COVERALLS_REPO_TOKEN }}"
51+
COVERALLS_GIT_BRANCH: "${{ github.ref }}"
52+
```
53+
4154
### [Jest](https://jestjs.io/)
4255
4356
- Install [jest](https://jestjs.io/docs/en/getting-started)

0 commit comments

Comments
 (0)