https://github.com/stryker-mutator/github-action

https://github.com/stryker-mutator/github-action

hacktoberfest mutation-testing stryker

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/stryker-mutator/github-action
• Owner: stryker-mutator
• License: apache-2.0
• Created: 2022-10-29T09:02:34.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T14:33:31.000Z (3 months ago)
• Last Synced: 2024-10-25T18:27:25.106Z (3 months ago)
• Topics: hacktoberfest, mutation-testing, stryker
• Language: Shell
• Size: 20.5 KB
• Stars: 4
• Watchers: 6
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Run Stryker GitHub Action

This action runs [Stryker.NET](https://stryker-mutator.io/docs/stryker-net/introduction/) on your specified test project.

## Inputs

### `tool`

**Required** The version of stryker that needs to be ran. accepted values: 'Stryker.NET'

### `testProject`

**Required** The path to the directory of the test project that needs to be tested by Stryker. No default.

### `breakAt`

**Optional** Set the minimal mutation score threshold for the action to succeed. If the threshold is not met, the action will fail the pipeline. The default value is `0`. 

## Outputs

### `html-report`

This action generates an HTML report from the Stryker run, which can be uploaded as an artifact.

## Example usage

```yaml

# File: .github/workflows/mutation-test.yaml

on:

  # Run the mutation tests when changes are pushed to the main branch

  push:

    branches:

      - 'main'

jobs:

  mutation-test:

    uses: actions/checkout@v3

    uses: stryker-mutator/[email protected]

      with:

        testProject: "BusinessLogic.Test/" # required

        breakAt: "75" # Optional

    uses: actions/upload-artifact@v3

      with:

        name: html-report

        path: ${{github.workspace}}/BusinessLogic.Test/StrykerOutput/**/**/*.html