| gatling_enterprise_url | URL of your Gatling Enterprise server (needed only for self-hosted instances). | no | https://cloud.gatling.io |
| gatling_enterprise_api_url | Allows configuring a separate URL for the Gatling Enterprise API, this is NOT required for typical use cases. | no | — |
| api_token | A Gatling Enterprise API token with at least Start permission (we recommend storing it securely using GitHub's encrypted secrets; see https://docs.github.com/en/actions/security-guides/encrypted-secrets#using-encrypted-secrets-in-a-workflow). Alternatively, you can define your token in an environment variable named GATLING_ENTERPRISE_API_TOKEN. | no | — |
| simulation_id | The ID of the simulation to run. | yes | — |
| extra_system_properties | Additional Java system properties, will be merged with the simulation's configured system properties. Must be formatted as a JSON object, e.g. {"MySysProp":"Some value"}. | no | — |
| extra_environment_variables | Additional environment variables, will be merged with the simulation's configured environment variables. Must be formatted as a JSON object, e.g. {"MY_ENV_VAR":"Some value"}. | no | — |
| override_load_generators | Overrides the simulation's load generators configuration. Must be formatted as a JSON object, e.g. {"4a399023-d443-3a58-864f-3919760df78b":{"size":1,"weight":60},"c800b6d9-163b-3db7-928f-86c1470a9542":{"size":1,"weight":40}} (weights are optional). | no | — |
| title | Give a title to the run started by this action. | no | — |
| description | Give a description to the run started by this action. | no | — |
| fail_action_on_run_failure | Whether the action should fail if the run ends with a failed status. True by default. If set to false, some of this action's outputs may be missing. | no | true |
| wait_for_run_end | Whether the action should wait for the end of the Gatling Enterprise simulation run before terminating. True by default. If set to false, some of this action's outputs may be missing. | no | true |
| run_summary_enabled | Assuming wait_for_run_end is also true, will regularly log a summary of the ongoing run to the console until it finishes. True by default. | no | true |
| run_summary_initial_refresh_interval | Initial interval before displaying a new summary of the ongoing run in the console, in seconds. 5 seconds by default. Should be a multiple of 5 (otherwise it will be rounded up). Only used a limited number of times (set by run_summary_initial_refresh_count) before switching to the interval set by run_summary_permanent_refresh_interval. | no | 5 |
| run_summary_initial_refresh_count | Number of times to use run_summary_initial_refresh_interval as the interval before displaying a new summary of the ongoing run in the console. 12 times by default (i.e. 60 seconds with the default run_summary_initial_refresh_interval of 5 seconds). After that, run_summary_permanent_refresh_interval will be used. This allows to avoid spamming the log output once the test run is well underway. | no | 12 |
| run_summary_refresh_interval | Interval before displaying a new summary of the ongoing run in the console, in seconds. 60 seconds by default. Should be a multiple of 5 (otherwise it will be rounded up). | no | 60 |