/godot-gut-ci

Run your Godot GUT tests on CI

Primary LanguageGDScript

Godot GUT CI

This GitHub action allows you to run your Godot GUT tests, so you can make sure nothing is broken :).

How to use

Create a folder called .github/workflows in the root project folder. Then create a yaml file to configure your tests, for example godot-tests.yml.

Yaml content

Copy and paste the following content in your yaml file:

name: "godot gut test"
on: push

jobs:
  execute-gut:
    name: Run GUT tests
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Docker test
        uses: ceceppa/godot-gut-ci@main

GUT parameters

The action parameter can be customised using the with property:

parameter description default
godot_version The godot version you want to use to run your tests 3.2.2
gut_params The parameters to pass to GUT (https://github.com/bitwes/Gut/wiki/Command-Line)

NOTE: If you're customising unit_test or integration_test, don't forget to specify the res:// prefix.

Example

name: "godot gut test"
on: push

jobs:
  execute-gut:
    name: Run GUT tests
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Docker test
        uses: ceceppa/godot-gut-ci@main
        with:
          godot_version: 3.2.1 # uses godot 3.2.1
          gut_params: -gdir=res://tests -gsuffix=.test.gd -gprefix=