Skip to content

Commit 83a5624

Browse files
authored
Merge pull request #8402 from steko/patch-1
Add documentation about webhooks for Gitea
2 parents 031f6ab + 5c7e238 commit 83a5624

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/webhooks.rst

+38
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,44 @@ GitLab
9393
* Leave the default **Push events** selected and mark **Tag push events** also
9494
* Finish by clicking **Add Webhook**
9595

96+
Gitea
97+
~~~~~
98+
99+
These instructions apply to any Gitea instance.
100+
101+
.. warning::
102+
103+
This isn't officially supported, but using the "GitHub webhook" is an effective workaround,
104+
because Gitea uses the same payload as GitHub. The generic webhook is not compatibile with Gitea.
105+
See `issue #8364`_ for more details. Official support may be implemented in the future.
106+
107+
On Read the Docs:
108+
109+
* Manually create a "GitHub webhook" integration
110+
(this will show a warning about the webhook not being correctly set up,
111+
that will go away when the webhook is configured in Gitea)
112+
113+
On your Gitea instance:
114+
115+
* Go to the :guilabel:`Settings` > :guilabel:`Webhooks` page for your project on your Gitea instance
116+
* Create a new webhook of type "Gitea"
117+
* For **URL**, use the URL of the integration on Read the Docs,
118+
found on the :guilabel:`Admin` > :guilabel:`Integrations` page
119+
* Leave the default **HTTP Method** as POST
120+
* For **Content type**, both *application/json* and
121+
*application/x-www-form-urlencoded* work
122+
* Leave the **Secret** field blank
123+
* Select **Choose events**,
124+
and mark **Branch or tag creation**, **Branch or tag deletion** and **Push** events
125+
* Ensure **Active** is enabled; it is by default
126+
* Finish by clicking **Add Webhook**
127+
* Test the webhook with :guilabel:`Delivery test`
128+
129+
Finally, on Read the Docs, check that the warnings have disappeared
130+
and the delivery test triggered a build.
131+
132+
.. _issue #8364: https://github.com/readthedocs/readthedocs.org/issues/8364
133+
96134
.. _webhook-integration-generic:
97135

98136
Using the generic API integration

0 commit comments

Comments
 (0)