mirror of https://github.com/yeslayla/run-gut-tests-action.git synced 2025-01-13 12:33:41 +01:00

GitHub Action to run GUT tests for Godot

Go to file

Joseph Manley 77ba28181d Merge pull request #5 from josephbmanley/feature/runLocally Allow running tests directly on runner		2021-02-11 19:06:55 -05:00
.github/workflows	Allow action to run locally	2021-02-11 19:01:02 -05:00
dist	Allow user to change executable path	2021-02-11 19:03:58 -05:00
test_proj	Intial commit	2020-07-25 17:09:22 -04:00
.gitignore	Intial commit	2020-07-25 17:09:22 -04:00
action.yml	Allow user to change executable path	2021-02-11 19:03:58 -05:00
LICENSE	Intial commit	2020-07-25 17:09:22 -04:00
main.js	Allow user to change executable path	2021-02-11 19:03:58 -05:00
package-lock.json	Bump @actions/core from 1.2.4 to 1.2.6	2020-10-01 17:41:51 +00:00
package.json	Allow action to run locally	2021-02-11 19:01:02 -05:00
ReadMe.md	Allow user to change executable path	2021-02-11 19:03:58 -05:00

ReadMe.md

Run GUT tests

This is an action that runs GUT tests for Godot to easily automate testing.

Usage

This action will run GUT tests inside of a docker image for your Godot project.

Example:

steps:
- uses: josephbmanley/run-gut-tests-action@[VERSION]
  with:
    directory: client

Inputs

containerImage

The docker image  where GUT tests are inside of. Defaults to `barichello/godot-ci:latest`

useContainer

Boolean value of whether or not to run container. Defaults to `true`

godotExecutable

Path of Godot binary to call when running GUT tests. Defaults to `godot`

Configure GUT

This action requires you to configure GUT using the .gutconfig.json file which would be located in the root directory of your project.

Here is an example .gutconfig.json:

{
    "dirs":[
        "res://tests/"
    ],
    "include_subdirs":true,
    "ignore_pause":true,
    "log_level":2,
    "should_exit":true,
    "should_maximize":false
}

For more information on the config file, see the GUT wiki.