https://github.com/betrybe/stryker-evaluator-action

https://github.com/betrybe/stryker-evaluator-action

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/betrybe/stryker-evaluator-action
• Owner: betrybe
• Created: 2020-05-20T01:29:04.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-08-25T17:41:21.000Z (over 1 year ago)
• Last Synced: 2024-11-09T18:50:13.215Z (about 2 months ago)
• Language: JavaScript
• Size: 471 KB
• Stars: 0
• Watchers: 38
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# stryker-evaluator-action

Stryker evaluator action for Tryber projects

This action evaluate Tryber projects with [Stryker](https://www.npmjs.com/package/stryker) library.

## Inputs

- `pr_author_username`

  **Required**

  Pull Request author username.

## Outputs

- `result`

  Stryker unit tests JSON results in base64 format.

## Usage example

```yml

- name: Fetch Stryker evaluator

  uses: actions/checkout@v2

  with:

    repository: betrybe/stryker-evaluator-action

    ref: v3.1

    token: ${{ secrets.GIT_HUB_PAT }}

    path: .github/actions/stryker-evaluator

- name: Run Stryker evaluation

  id: evaluator

  uses: ./.github/actions/stryker-evaluator

  with:

    pr_author_username: ${{ github.event.inputs.pr_author_username }}

```

## How to get result output

```yml

- name: Run Stryker evaluation

  id: stryker_evaluator

  uses: ./.github/actions/stryker-evaluator

  with:

    pr_author_username: ${{ github.event.inputs.pr_author_username }}

- name: Next step

  uses: another-github-action

  with:

    param: ${{ steps.stryker_evaluator.outputs.result }}

```

## Project constraints

The description of the requirement into `.trybe/requirements.json` must be `{FILE_NAME} mutation test` where `FILE_NAME` is the real filename without the extensions.

> Example: for the `fetchItem.test.js` validation the requirement description must be `fetchItem mutation test`.

The example `fetchItem.test.js` file's code:

```javascript

describe('Test #1' () => {

  it('unit test1', () => {});

  it('unit test2', () => {});

  it('unit test3', () => {});

});

describe('Test #2' () => {

  ...

});

describe('Test #3' () => {

  ...

});

```

The `.trybe/requirements.json` file must have the following structure:

```json

{

  "requirements": [{

    "description": "fetchItem mutation test",

    "bonus": false

  }]

}

```

Each new `.test.js` file must have an equivalent `requirement`.