Skip to content

Commit 97fd713

Browse files
committed
Let there be README
1 parent 407cc19 commit 97fd713

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# GitHub ESLint runner
1+
# GitHub Jest runner
22

33
This action executes Jest test runner without any previous action/build step or Docker required.
44

55
## Prerequisites
66

77
### Jest
8-
You must have the ESLint running locally for the action to execute. It will use the same rules as you do locally.
9-
More info [on the ESLint getting started guide](https://eslint.org/docs/user-guide/getting-started#installation-and-usage)
8+
You must have the Jest running locally for the action to execute.
9+
More info [on the Jest getting started guide](https://jestjs.io/docs/en/getting-started)
1010

1111
## Usage
1212

@@ -16,24 +16,24 @@ This is the simplest example to get it running:
1616
```
1717
workflow "New workflow" {
1818
on = "push"
19-
resolves = ["ESLint"]
19+
resolves = ["Jest"]
2020
}
2121
22-
action "ESLint" {
23-
uses = "stefanoeb/eslint-action@master"
22+
action "Jest" {
23+
uses = "stefanoeb/jest-action@master"
2424
}
2525
```
2626

27-
By default it will run ESLint through all the files in the project. But you can also specify a glob of files on the `args`, just like ESLint:
27+
By default it will run Jest on all the test files in the project. But you can also specify a glob of files on the `args`, just like on the Jest CLI, as well as options:
2828
```
2929
workflow "New workflow" {
3030
on = "push"
31-
resolves = ["ESLint"]
31+
resolves = ["Jest"]
3232
}
3333
34-
action "ESLint" {
35-
uses = "stefanoeb/eslint-action@master"
36-
args = "index.js src/**.js"
34+
action "Jest" {
35+
uses = "stefanoeb/jest-action@master"
36+
args = "**.test.js --ci"
3737
}
3838
```
3939

0 commit comments

Comments
 (0)