README.md

Gremlins Action

The official GitHub Action for Gremlins.

Example usage

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.