Dokploy / Dokploy/dokploy

Support specifying commit info in the url when triggering deploy by webhook

Open
#2,484 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
37.4k
Forks
3k
Avg merge
1d 3h
Merged PRs (30d)
73

Description

What problem will this feature address?

Currently, the origin of these info are undocumented:

Image

According to the code,

https://github.com/Dokploy/dokploy/blob/7273c636a0725881ef36440ae687c4e3ba84dd25/apps/dokploy/pages/api/deploy/%5BrefreshToken%5D.ts#L248-L313

it assumes the webhook are always github/gitlab/bitbucket/gitea/docker format. It would be nice if there's a simpler and documented way to specify these for custom use (eg. manually curl in CI).

Describe the solution you'd like

https://example.com/api/deploy/foo-bar?commit_id=&commit_message=&..., or JSON body.

Describe alternatives you've considered

N/A

Additional context

No response

Will you send a PR to implement it?

No

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in apps/dokploy/pages/api/deploy/[refreshToken].ts, especially lines 248-313, and trace how webhook payloads provide commit information. Define and document a custom URL or JSON-body input for commit_id, commit_message, and the other required fields, then verify that manually triggered deploy webhooks use those values.

Written by the indexing model from the issue text.

Assessment

Tech stack
nextjs, typescript
Domain
api, devops
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.