trackslash
TRACK-99 P2

Document how merges to main deploy through Dokploy's GitHub App

0
All issues

Description

DEPLOYMENT.md covers the image, migrations and runtime settings, but it doesn't say how a merge to main reaches Dokploy. Merges weren't deploying for two reasons:

  • Dokploy set its GitHub App's webhook URL from the private address the dashboard was open at, which GitHub can't reach.
  • A repository webhook sent form-encoded payloads, and Dokploy answered every one with 301 "Branch Not Match".

Do

  • Add a short section to DEPLOYMENT.md saying that:
    • the GitHub App webhook (/api/deploy/github) does the triggering, and it chooses which apps to deploy by provider, owner, repository, branch and trigger;
    • the App's Webhook URL has to be publicly reachable, and here is how to change it;
    • you shouldn't also add a repository webhook with the app's own URL, because every merge would then deploy twice;
    • if you do use that URL, the content type must be JSON.

This is a docs-only change. Merging it also serves as a test that auto-deploy now works.

Sub-issues

0

Linked issues

0

GitHub

0

No branches or pull requests linked.

Comments

1
Bradley

Done in #190, squash-merged as 0e637d5. DEPLOYMENT.md now has a "Deploying on Merge" section.

That merge was also the first one to deploy through the Dokploy GitHub App, after its Webhook URL was moved to a public address. The repository webhooks are gone, so each merge deploys once.