README.md

shaker

This action uses shaker in your GitHub workflow to detect flakiness. If the job ends in failure, flakes were detected and errors will be reported.

Shaker supports projects using maven or pytest.

Usage

Add the following code to your GitHub Actions workflow configuration

# Checks-out your repository under $GITHUB_WORKSPACE so Shaker can access it
- uses: actions/checkout@v2.3.4
- name: Shaker
  uses: STAR-RG/shaker@main
  with:
    # Tool
    # Currently supported tools: maven, pytest
    # Required
    # Example: testing_tool: maven
    tool: "maven"

    # Pass extra arguments to the tool
    # Optional
    # Example: extra_arguments: -DModule.skip.tests=true
    extra_arguments: ""

    # Number of Shaker runs
    # Optional, default: 3
    # Example: runs: "3"
    runs: "3"

Inputs

Input	Description
tool	Specifies the tool required to run the tests. Currently supported: maven and pytest.
extra_arguments	Optional. Passes extra arguments to the testing tool. For example, you can pass -DModule.skip.tests=true to tell Maven to skip a certain module.
runs	Optional, default: 3. Specifies how many times Shaker will run.

Examples

To see examples visit our website.