Skip to content

A github action to execute pitest and show a comment with the summary of the execution

Notifications You must be signed in to change notification settings

isamadrid90/gradle-pitest-comment-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Introduction

Badge for tags Stable stability badge

This action makes easier to include mutation testing as a part of a Github Action pipeline.

If you find this action useful let me know by adding a โญ this encourage me to keep working on it.

Happy to hear any suggestions or improvements.

What it does โ“

The purpose of this action is to execute pitest, upload the report as an artifact and add a comment with the summary of the execution

Prerequisites ๐Ÿ“

  • Gradle
  • PITest plugin
plugins {
    id("info.solidsoft.pitest") version "1.15.0"
}
  • PITest configuration working in local, here an example:
pitest {
    junit5PluginVersion = "1.2.1"
    targetClasses= listOf("package-to-check")
    outputFormats = listOf("HTML") //this is important because it will update it as an artifact
}

How to use it ๐Ÿ› ๏ธ

Add action as step

uses: isamadrid90/gradle-pitest-comment-action@v2.0.0
with:
  repo-token: ${{ secrets.GITHUB_TOKEN }}
  reports-retention: 1
  reports-path: "project/build/reports/pitest"
  working-directory: project

Inputs

Name Value Default Required Description
repo-token String - yes Token to upload reports as artifact
reports-retention Int 1 no Retention for the uploaded reports
reports-path String "build/reports/pitest" no The path where the pitest reports are saved
working-directory String "." no Path to directory where gradle can be executed

Screenshots ๐Ÿ“ธ

img.png

About

A github action to execute pitest and show a comment with the summary of the execution

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages