Skip to content

Commit

Permalink
fix: atualiza README
Browse files Browse the repository at this point in the history
  • Loading branch information
Euclécio Josias Rodrigues authored and Euclécio Josias Rodrigues committed Feb 1, 2021
1 parent a880d95 commit 7f53f92
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,36 @@ This action evaluate Tryber projects with [Jest](https://jestjs.io/) library.

## Inputs

### `npm-start`
- `npm-start`

Run npm start and waits to url before testing
Optional

### `wait-for`
Run npm start and waits to url before testing.

Url that npm start command waits for
- `wait-for`

### `pr_author_username`
Optional

Pull Request author username
Url that npm start command waits for

## Outputs
- `pr_author_username`

**Required**

### `result`
Pull Request author username.

Jest unit tests JSON results in base64 format.
## Outputs

### `pr-number`
- `result`

Pull Request number that trigger build.
Jest unit tests JSON results in base64 format.

## Usage example

```yml
- uses: betrybe/jest-evaluator-action@v8
with:
pr_author_username: ${{ github.event.inputs.pr_author_username }}
with:
npm-start: true # false is default
wait-for: 'http://localhost:8080' # http://localhost:3000 is default
Expand All @@ -41,6 +45,8 @@ Pull Request number that trigger build.
- name: Jest evaluator
id: evaluator
uses: betrybe/jest-evaluator-action@v8
with:
pr_author_username: ${{ github.event.inputs.pr_author_username }}
- name: Next step
uses: another-github-action
with:
Expand Down

0 comments on commit 7f53f92

Please sign in to comment.