diff --git a/docs/Plugins/webhook.md b/docs/Plugins/webhook.md index 4baffa28239..9c03e7f0faf 100644 --- a/docs/Plugins/webhook.md +++ b/docs/Plugins/webhook.md @@ -56,9 +56,9 @@ You can copy the generated deployment curl commands to your CI/CD script to post | Key | Required | Notes | |:------------------:|:--------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | id | ✔️ Yes | This will be the unique ID of table cicd_deployments. This key replaced pipeline_id for clarity. | -| createdDate | ✖️ No | Time. E.g. 2020-01-01T12:00:00+00:00
No default value. | -| startedDate | ✔️ Yes | Time. E.g. 2020-01-01T12:00:00+00:00
No default value. | -| finishedDate | ✔️ Yes | Time. E.g. 2020-01-01T12:00:00+00:00
No default value. | +| createdDate | ✖️ No | The time this deploy pipeline starts. E.g. 2020-01-01T12:00:00+00:00
No default value. | +| startedDate | ✔️ Yes | The time when the first deploy to a certain repo starts. E.g. 2020-01-01T12:00:00+00:00
No default value. | +| finishedDate | ✔️ Yes | The time when the last deploy to a certain repo ends. E.g. 2020-01-01T12:00:00+00:00
No default value. | | environment | ✖️ No | The environment this deployment happens. For example, `PRODUCTION` `STAGING` `TESTING` `DEVELOPMENT`.
The default value is `PRODUCTION` | | result | ✖️ No | deployment result, one of the values : `SUCCESS`, `FAILURE`, `ABORT`, `MANUAL`,
The default value is `SUCCESS`. | | displayTitle | ✖️ No | A readable title for the deployment. | @@ -70,6 +70,7 @@ You can copy the generated deployment curl commands to your CI/CD script to post | deploymentCommits.finishedDate | ✔️ Yes | The end time of the deploy to this repo. E.g. 2020-01-01T12:00:00+00:00
No default value. | | deploymentCommits.commitSha | ✔️ Yes | Commit sha that triggers the deploy in this repo | | deploymentCommits.commitMsg | ✖️ No | Commit sha of the deployment commit message | +| deploymentCommits.result | ✖️ No | The result of the deploy to this repo. | | deploymentCommits.displayTitle | ✖️ No | A readable title for the deployment to this repo. | | deploymentCommits.name | ✖️ No | Deprecated. | @@ -96,6 +97,8 @@ curl /api/rest/plugins/webhook/1/deployments -X 'POST' -H 'Authori { "repoUrl":"required-repo-url", "refName": "optional-release-v0.17", + "startedDate":"2020-01-01T11:00:00+00:00", + "finishedDate":"2020-01-02T11:00:00+00:00", "commitSha":"c1", "commitMsg":"optional-msg-1", "name":"optional, if null, it will be deployment for {commit_sha}", @@ -104,6 +107,8 @@ curl /api/rest/plugins/webhook/1/deployments -X 'POST' -H 'Authori { "repoUrl":"repo-2", "refName": "optional-release-v0.17", + "startedDate":"2020-01-01T11:00:00+00:00", + "finishedDate":"2020-01-02T11:00:00+00:00", "commitSha":"c2", "commitMsg":"optional-msg-2", "name":"optional, if null, it will be deployment for {commit_sha}", diff --git a/versioned_docs/version-v1.0/Plugins/webhook.md b/versioned_docs/version-v1.0/Plugins/webhook.md index dc165117830..296a26e9991 100644 --- a/versioned_docs/version-v1.0/Plugins/webhook.md +++ b/versioned_docs/version-v1.0/Plugins/webhook.md @@ -56,9 +56,9 @@ You can copy the generated deployment curl commands to your CI/CD script to post | Key | Required | Notes | |:------------------:|:--------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | id | ✔️ Yes | This will be the unique ID of table cicd_deployments. This key replaced pipeline_id for clarity. | -| createdDate | ✖️ No | Time. E.g. 2020-01-01T12:00:00+00:00
No default value. | -| startedDate | ✔️ Yes | Time. E.g. 2020-01-01T12:00:00+00:00
No default value. | -| finishedDate | ✔️ Yes | Time. E.g. 2020-01-01T12:00:00+00:00
No default value. | +| createdDate | ✖️ No | The time this deploy pipeline starts. E.g. 2020-01-01T12:00:00+00:00
No default value. | +| startedDate | ✔️ Yes | The time when the first deploy to a certain repo starts. E.g. 2020-01-01T12:00:00+00:00
No default value. | +| finishedDate | ✔️ Yes | The time when the last deploy to a certain repo ends. E.g. 2020-01-01T12:00:00+00:00
No default value. | | environment | ✖️ No | The environment this deployment happens. For example, `PRODUCTION` `STAGING` `TESTING` `DEVELOPMENT`.
The default value is `PRODUCTION` | | result | ✖️ No | deployment result, one of the values : `SUCCESS`, `FAILURE`, `ABORT`, `MANUAL`,
The default value is `SUCCESS`. | | displayTitle | ✖️ No | A readable title for the deployment. | @@ -70,6 +70,7 @@ You can copy the generated deployment curl commands to your CI/CD script to post | deploymentCommits.finishedDate | ✔️ Yes | The end time of the deploy to this repo. E.g. 2020-01-01T12:00:00+00:00
No default value. | | deploymentCommits.commitSha | ✔️ Yes | Commit sha that triggers the deploy in this repo | | deploymentCommits.commitMsg | ✖️ No | Commit sha of the deployment commit message | +| deploymentCommits.result | ✖️ No | The result of the deploy to this repo. | | deploymentCommits.displayTitle | ✖️ No | A readable title for the deployment to this repo. | | deploymentCommits.name | ✖️ No | Deprecated. | @@ -96,6 +97,8 @@ curl /api/rest/plugins/webhook/1/deployments -X 'POST' -H 'Authori { "repoUrl":"required-repo-url", "refName": "optional-release-v0.17", + "startedDate":"2020-01-01T11:00:00+00:00", + "finishedDate":"2020-01-02T11:00:00+00:00", "commitSha":"c1", "commitMsg":"optional-msg-1", "name":"optional, if null, it will be deployment for {commit_sha}", @@ -104,6 +107,8 @@ curl /api/rest/plugins/webhook/1/deployments -X 'POST' -H 'Authori { "repoUrl":"repo-2", "refName": "optional-release-v0.17", + "startedDate":"2020-01-01T11:00:00+00:00", + "finishedDate":"2020-01-02T11:00:00+00:00", "commitSha":"c2", "commitMsg":"optional-msg-2", "name":"optional, if null, it will be deployment for {commit_sha}",