timeouts.adoc 947 B

12345678910111213141516171819202122232425262728
  1. [#timeout]
  2. = Timeouts
  3. By default, actions in OliveTin have a **3 second timeout** for all actions.
  4. This means that OliveTin will kill the action if it is running for longer than
  5. the timeout, which can be useful to stop commands running for a long time.
  6. You can set your own timeouts like this;
  7. [source,yaml]
  8. ----
  9. actions:
  10. - title: My special action
  11. shell: sleep 5
  12. timeout: 10
  13. ----
  14. NOTE: Allowing commands to run for infinity just doesn't seem to make sense, or
  15. at least is probably a bad case for OliveTin. Therefore, if you set a timeout
  16. *less than 3 seconds*, OliveTin will overwrite your Timeout and default to 3
  17. seconds. If you think you have a use case where a shorter (or infinite) timeout
  18. makes sense, please open an issue and let's discuss.
  19. == Check the logs
  20. If a action really does "time out", it will show in the logs with "(timed out)" next to the exist code;
  21. image::action_customization/timeout-logs/timeoutLogs.png[]