kubernetes
/
git-sync
mirror of https://github.com/kubernetes/git-sync.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README based on comments in #110

This commit is contained in:
Thomas Jackson 2019-01-17 15:49:04 -08:00
parent 39ca0a2ca0
commit 5c63dc9cb5
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -12,6 +12,7 @@ this, it uses a git worktree in a subdirectory of the `--root` and flips a
symlink. symlink.
git-sync can also be configured to make webhook call upon sucessful git repo syncronisation. The call is made when right after the symlink is updated. git-sync can also be configured to make webhook call upon sucessful git repo syncronisation. The call is made when right after the symlink is updated.
## Usage ## Usage
``` ```
@ -35,11 +36,12 @@ docker run -d \
## Example of webhooks usage ## Example of webhooks usage
**Webhook config example** **Webhook config example**
A webhook config must be valid JSON. If ```success``` is not specified in the config, git-sync will not wait for a response. A webhook config must be valid JSON. If `success` is not specified in the config, git-sync will continue regardless of response code (including errors).
```json ```json
{ {
"url": "http://localhost:9090/-/reload", "url": "http://localhost:9090/-/reload",
"method": "POST|GET", "method": "POST",
"success": 200 "success": 200
} }
``` ```