This GitHub Action automates the execution of GdUnit4 unit tests within the Godot Engine 4.x environment.
It provides flexibility in configuring the Godot version, GdUnit4 version, test paths, and other parameters to suit your testing needs.

• Inputs
• Usage
• Examples
• License
• Contributing

A GdUnit4 version should be specified as a string, such as v4.2.1. To run on the latest release, use latest, and for the latest unreleased version, use master. To keep the version installed in your project, use installed.

- uses: MikeSchulze/gdUnit4-action@v1
  with:
    # The version of Godot in which the tests should be run. (e.g., "4.2.1")
    godot-version: ''
    
    # The Godot status (e.g., "stable", "rc1", "dev1")
    # Default: stable
    godot-status: ''
    
    # Set to true to run on Godot .Net version to run C# tests
    # Default: false
    godot-net: ''
    
    # The version of GdUnit4 to use. (e.g. "v4.2.0", "latest", "master").
    # Default: latest
    version: ''
    
    # Comma-separated or newline-separated list of directories containing test to execute..
    paths: ''

    # The test execution timeout in minutes.
    # Default: 10
    timeout: ''

    # The number of retries if the tests fail. (This can be used for flaky test)
    # Default: 0 
    retries: ''
    
    # Additional arguments to pass to GdUnit4 (see https://mikeschulze.github.io/gdUnit4/advanced_testing/cmd/).
    arguments: ''

    # The name of the test report file.
    report-name: ''

This example runs all tests located under res://myproject/tests on Godot-4.2.1-stable with the latest GdUnit4 release.

- uses: actions/checkout@v4
- uses: MikeSchulze/gdUnit4-action@v1
  with:
    godot-version: '4.2.1'
    paths: 'res://myproject/tests'
    report-name: 'test-result.xml'

In this example, all tests located in 'myproject1/tests' and 'myproject2/tests' are executed using the master branch version of GdUnit4

- uses: actions/checkout@v4
- uses: MikeSchulze/gdUnit4-action@v1
  with:
    godot-version: '4.2.1'
    version: 'master'
    paths: |
      res://myproject1/tests
      res://myproject2/tests
    report-name: 'test-result.xml'

The scripts and documentation in this project are released under the MIT License

• Give Feedback on the gdUnit GitHub Discussions page.
• Suggest Improvements by creating a new feature request issue on the gdUnit GitHub Issues page.
• Report Bugs by creating a new bug report issue on the gdUnit GitHub Issues page.

Thank you for your interest in contributing to GdUnit4!
To ensure a smooth and collaborative contribution process, please review our contribution guidelines before getting started. These guidelines outline the standards and expectations we uphold in this project.

Code of Conduct: As a contributor, it is important to respect and follow this code to maintain a positive and inclusive community.

Using GitHub Issues: We utilize GitHub issues for tracking feature requests and bug reports. If you have a general question or wish to engage in discussions, we recommend joining the GdUnit Discord Server for specific inquiries.

We value your input and appreciate your contributions to make gdunit4-action even better!