https://github.com/go-gremlins/gremlins-action

The official GitHub Action for Gremlins.
https://github.com/go-gremlins/gremlins-action

continuous-integration go golang gremlins mutation-testing testing-tools

Last synced: about 1 month ago
JSON representation

The official GitHub Action for Gremlins.

• Host: GitHub
• URL: https://github.com/go-gremlins/gremlins-action
• Owner: go-gremlins
• License: apache-2.0
• Created: 2022-08-16T06:27:04.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2026-02-06T05:03:40.000Z (2 months ago)
• Last Synced: 2026-02-11T17:51:30.116Z (2 months ago)
• Topics: continuous-integration, go, golang, gremlins, mutation-testing, testing-tools
• Language: TypeScript
• Homepage: https://gremlins.dev
• Size: 1010 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Gremlins Action

The official [GitHub Action](https://github.com/features/actions)

for [Gremlins](https://github.com/go-gremlins/gremlins).

[![GitHub release (latest by semver)](https://img.shields.io/github/v/release/go-gremlins/gremlins-action?logo=github)](https://github.com/go-gremlins/gremlins-action/releases/latest)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/go-gremlins/gremlins-action/build-test?logo=github)](https://github.com/go-gremlins/gremlins-action/actions/workflows/test.yml)

[![Codecov](https://img.shields.io/codecov/c/github/go-gremlins/gremlins-action?logo=codecov)](https://codecov.io/gh/go-gremlins/gremlins-action)

[![Codacy grade](https://img.shields.io/codacy/grade/1da2ebb82033477298c56cf11ce3f716?logo=codacy)](https://www.codacy.com/gh/go-gremlins/gremlins-action/dashboard?utm_source=github.com&utm_medium=referral&utm_content=go-gremlins/gremlins-action&utm_campaign=Badge_Grade)

[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/go-gremlins/gremlins-action?logo=codeclimate)](https://codeclimate.com/github/go-gremlins/gremlins-action/maintainability)

## Example usage

```yaml

name: gremlins

on:

  pull_request:

  push:

jobs:

  gremlins:

    - uses: actions/checkout@v4

    - uses: actions/setup-go@v4

      with:

        go-version: '1.21'

    - uses: go-gremlins/gremlins-action@v1

      with:

        version: latest

        args: --tags="tag1,tag2"

        workdir: test/dir

```

## Customization

| Name           | Type     | Default  | Description                                              |

|----------------|----------|----------|----------------------------------------------------------|

| `version`**¹** | `string` | `latest` | Te version of Gremlins to use                            | 

| `args`         | `string` |          | The command line arguments to pass to `gremlins unleash` |

| `workdir`      | `string` | `.`      | Working directory relative to repository root            |  

> **¹** Can be `latest`, a fixed version like `v0.1.2` or a semver range like `~0.2`. In this case this

> will return `v0.2.2`.