Skip to content

config.md: clarify timeout of hooks is OPTIONAL #604

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

config.md: clarify timeout of hooks is OPTIONAL #604

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ If a hook returns a non-zero exit code, then an error is logged and the remainin
```

`path` is REQUIRED for a hook.
`args` and `env` are OPTIONAL.
`args`, `env` and `timeout` are OPTIONAL.
Copy link
Contributor

@wking wking Oct 28, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also covered by #427 which cleans up a lot of other hook spec too.

Copy link
Member Author

@coolljt0725 coolljt0725 Oct 28, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wking didn't find that :)

`timeout` is the number of seconds before aborting the hook.
The semantics are the same as `Path`, `Args` and `Env` in [golang Cmd](https://golang.org/pkg/os/exec/#Cmd).

Expand Down