[TASK] Document Forgejo and Gitea webhook support - #526
Draft
CybotTM wants to merge 1 commit into
Draft
Conversation
Intercept gained support for Forgejo and Gitea push webhooks, so those hosts no longer need a mirror on another platform. Self-hosted instances work on any domain, the domain is approved once by the Documentation Team along with the repository. Add a setup section for them next to the existing ones, extend the list of supported hosts and rewrite the "Foreign setups" paragraph, which until now told those users to build a mirror. Two enumerations elsewhere named the supported hosts individually and would have gone stale again with the next host. They now link to the webhook page instead. One of them, in the rendering chapter, was already incomplete, it omitted Bitbucket. The new section has no screenshots yet, unlike its siblings. Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Draft — do not merge yet. This documents behaviour that is not deployed. It depends on TYPO3GmbH/site-intercept#305, which adds Forgejo/Gitea support to the documentation hook. Please merge this only once that change is released, otherwise this page promises something that still fails in production. I will mark it ready for review then.
Why
The Webhook page currently lists GitHub, Bitbucket and GitLab as the supported hosts, and the "Foreign setups" section tells everyone else to create a mirror on a supported platform. That is what a Forgejo user ran into on Slack, which led to TYPO3GmbH/site-intercept#304 and then to the implementation in TYPO3GmbH/site-intercept#305.
What changed
Two things worth a maintainer's opinion
No screenshots. Every sibling section has a figure per step under
Documentation/_Images/webhook/<host>/; the new section is text only, because I have no Forgejo instance to capture them from. Happy to add them if someone supplies the images — the original reporter runs an instance and may be willing.The note about "Test Delivery". Forgejo has no ping event; its Test Delivery button sends a synthetic push whose commit lists no changed files, so intercept accepts it and answers "no documentation changes" without rendering anything. The button therefore reports success while nothing happens, which is confusing enough to warrant the note. This is from Forgejo's source (
routers/web/repo/setting/webhook.go), not from an assumption.Verification
make test-docsrenders cleanly: 92 files, no warnings or errors. Both new cross-references resolve to real links in the rendered output. I compared the render against the unmodified branch to confirm this change adds no new unresolved references.