Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/timeout plugin #591

Merged
merged 4 commits into from
Mar 3, 2021
Merged

Feature/timeout plugin #591

merged 4 commits into from
Mar 3, 2021

Conversation

steveukx
Copy link
Owner

@steveukx steveukx commented Mar 1, 2021

No description provided.

The Timeout Plugin can be used to shut down the spawned `git` processes if they stop responding for a supplied time (in `ms`). The timeout is reset each time `git` outputs to either `stdOut` or `stdErr. When the timeout is reached, the `git` process is killed with message `SIGINT` - the interrupt signal which can be gracefully handled if necessary.

When a task is killed in this way, the `simple-git` task that called it will fail (rejecting the promise it returned and calling back with an `Error` if the trailing callback was supplied). The error message will include `TimeoutPlugin` and detail of the timeout that expired.
- Force closing a `git` process now emits a `GitPluginError` with detail of the timeout
- Move plugin documentation to separate markdowns in docs folder
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant