-
Notifications
You must be signed in to change notification settings - Fork 313
docs(webhook): add documentation for webhook feature #1207
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
Conversation
…related flags to run command docs Signed-off-by: Christopher Coco <[email protected]>
Signed-off-by: Christopher Coco <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1207 +/- ##
==========================================
- Coverage 63.08% 63.05% -0.03%
==========================================
Files 23 23
Lines 3142 3140 -2
==========================================
- Hits 1982 1980 -2
Misses 1050 1050
Partials 110 110 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Christopher Coco <[email protected]>
Signed-off-by: Christopher Coco <[email protected]>
|
Altered the example url to be app1.example.com. |
|
all the new command flags can also be specified via env var, and we may want to document this capability too. |
|
How about also include a sample webhook event payload? During your testing, have you seen issues with not receiving expected events due to various configuration such as unmatched secret, incorrect port, etc? If so, can you also include them in a troubleshooting section? |
Yeah sure I can add a sample webhook event payload. The payloads vary from each of the container registries so do you think having an example specifically shown would be good or just links to the documentation for each of the registries would be suffice? For troubleshooting, I can definitely add a section that shows errors that you might receive as well. |
…ables Signed-off-by: Christopher Coco <[email protected]>
links should suffice; if links not available, then include a sample payload from one of the registries will be good too. |
…payloads Signed-off-by: Christopher Coco <[email protected]>
|
Added those two sections. Let me know what you think. |
) Signed-off-by: Christopher Coco <[email protected]>
) Signed-off-by: Christopher Coco <[email protected]> (cherry picked from commit 18767ed)
Adds documentation for the webhook feature.
Changes:
runpage with new webhook related flagswebhookcommandruncommand