Skip to content

Commit

Permalink
Merge pull request #94 from telia-oss/document-webhook-subscriptions
Browse files Browse the repository at this point in the history
Document webhook subscriptions
  • Loading branch information
Kristian authored Apr 2, 2019
2 parents 537ba89 + 06642c6 commit 6038cf4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ A version is represented as follows:
If several commits are pushed to a given PR at the same time, the last commit will be the new version.

**Note on webhooks:**
This resource does not implement any caching, so it should work well with webhooks (should be subscribed to `push` events).
This resource does not implement any caching, so it should work well with webhooks (should be subscribed to `push` and `pull_request` events).
One thing to keep in mind however, is that pull requests that are opened from a fork and commits to said fork will not
generate notifications over the webhook. So if you have a repository with little traffic and expect pull requests from forks,
you'll need to discover those versions with `check_every: 1m` for instance. `check` in this resource is not a costly operation,
Expand Down

0 comments on commit 6038cf4

Please sign in to comment.