forked from TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request TYPO3-Documentation#71 from TYPO3-Documentation/fe…
…ature/document-new-webhook FEATURE: Add documentation for new webhook using intercept
- Loading branch information
Showing
9 changed files
with
72 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
.. include:: ../Includes.txt | ||
|
||
.. _webhook: | ||
|
||
======= | ||
Webhook | ||
======= | ||
|
||
This section describes how to add webhooks for auto rendering to an repository. | ||
|
||
.. _webhook-github: | ||
|
||
GitHub | ||
====== | ||
|
||
Add auto rendering for an Repository via GitHub webhook in five steps: | ||
|
||
.. rst-class:: bignums-xxl | ||
|
||
#. Go to "Settings" tab within the repository | ||
|
||
.. figure:: /images/webhook/github/repository-start.png | ||
:width: 932 | ||
|
||
#. Go to "Webhooks" section within the repository settings | ||
|
||
.. figure:: /images/webhook/github/settings-tab.png | ||
:width: 932 | ||
|
||
#. Add webhook | ||
|
||
.. figure:: /images/webhook/github/webhook-section.png | ||
:width: 932 | ||
|
||
#. Fill in webhook configuration | ||
|
||
#. Configure URL ``https://docs-hook.typo3.org`` for field "Payload URL". | ||
|
||
#. Select ``application/json`` as "Content type". | ||
|
||
#. Enable "SSL verification". | ||
|
||
#. Select ``Just the push event.`` for "Which events would you like to trigger this webhook?". | ||
|
||
#. Enable "Activate". | ||
|
||
#. Click on "Add webhook" | ||
|
||
.. figure:: /images/webhook/github/webhook-add.png | ||
:width: 932 | ||
|
||
#. Webhook was added | ||
|
||
GitHub should show an notice that creation of Webhook was successful. | ||
|
||
.. figure:: /images/webhook/github/webhook-added.png | ||
:width: 932 | ||
|
||
#. (Optional) visit intercept and check request | ||
|
||
If curious, visit https://intercept.typo3.com/admin/docs/deployments and | ||
check "Recent actions" (scroll down). The repository should have created an | ||
"Docs hook ping from github repository". | ||
|
||
.. figure:: /images/webhook/github/intercept-feedback.png | ||
:width: 932 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.