Provider adapters
Jenkins adapter
Reference for the Jenkins adapter. Request format, signature, status mapping and limits.
The Jenkins adapter accepts build results that your Jenkinsfiles post to Prodgator, and reads stages and logs from the Jenkins API. To set it up, see Connect Jenkins.
Request
| Header | Value |
|---|---|
| Hex HMAC-SHA256 of the raw body, keyed with the connection's webhook secret |
Body:
{
"projectName": "my-app/main",
"buildNumber": 42,
"buildStatus": "SUCCESS",
"buildUrl": "https://ci.example.com/job/my-app/job/main/42/",
"branch": "main",
"commit": "9fceb02d0ae598e95dc970b74767f19372d61af8",
"duration": 183000
}| Field | Required | Notes |
|---|---|---|
| Yes | Used as the workflow and repository name | |
| Yes | Run ID is | |
| No | Mapped as below. Missing means | |
| No | Link to the build | |
| No | ||
| No | ||
| No | Milliseconds |
Requests without or are ignored. A request with a bad or missing signature gets .
Status mapping
| Jenkins status | Prodgator status | Pipelines tab |
|---|---|---|
| , | Queued | |
| , | Running | |
| Awaiting approval | ||
| Success | ||
| , , | Failed | |
| Cancelled | ||
| , | Cancelled |
(usually test failures) counts as failed.
Stages and logs
Prodgator calls your Jenkins server with the stored username and API token:
- Build details:
- Stages: (Pipeline Stage View plugin)
- Console log:
Limits
- Deployment approvals are not available. Use the Jenkins step.
- Prodgator only hears about a build when your pipeline posts to it, so the snippet in reports finished builds.
- Freestyle jobs need their own post-build step that sends the same request.