An open API service indexing awesome lists of open source software.

https://github.com/lyndychivs/dotnet-stryker-action

GitHub Action for mutation testing with Stryker.NET via Docker
https://github.com/lyndychivs/dotnet-stryker-action

action actions dotnet github github-actions mutation report reporting stryker testing

Last synced: about 2 months ago
JSON representation

GitHub Action for mutation testing with Stryker.NET via Docker

Awesome Lists containing this project

README

          

# dotnet-stryker-action
GitHub Action for mutation testing with [Stryker.NET](https://stryker-mutator.io/docs/stryker-net/introduction/) via Docker.

## GitHub Action
This Action accepts a [Stryker Mutator .NET Configuration](https://stryker-mutator.io/docs/stryker-net/configuration) file (`.json` or `.yaml` format).

*Create a configuration file:*
```
dotnet stryker init
```

### Parameters
| Argument | Description | Default | Required |
| :--- | :--- | :--- | :--- |
| `configurationFile` | Path of the Stryker.NET configuration file. | — | Yes |
| `dashboardApiKey` | API key for authentication with the Stryker dashboard. | — | No |

#### Example 1
```yml
name: Run Stryker.NET

on: push

jobs:
mutation-testing:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v6

- name: Run Stryker.NET against Repository
uses: lyndychivs/dotnet-stryker-action@v1.5
with:
configurationFile: "stryker-config.json"
```
#### Example 2 - with Dashboard API Key
Check out the [Stryker Dashboard documentation here](https://stryker-mutator.io/docs/General/dashboard/); the API key is generated from the Dashboard site.
```yml
name: Run Stryker.NET with Dashboard Reporting

on: push

jobs:
mutation-testing:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v6

- name: Run Stryker.NET against Repository
uses: lyndychivs/dotnet-stryker-action@v1.5
with:
configurationFile: "stryker-config.json"
dashboardApiKey: ${{ secrets.STRYKER_DASHBOARD }} # API key saved in Secrets
```