Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update the desc of the started and finished date #760

Merged
merged 2 commits into from
Jun 3, 2024
Merged

docs: update the desc of the started and finished date #760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
472b996
docs: update the desc of the started and finished date
merico-devlake Jun 3, 2024
7461838
docs: add result to deploy commits payload
merico-devlake Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/Plugins/webhook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<br/> No default value. |
| startedDate | ✔️ Yes | Time. E.g. 2020-01-01T12:00:00+00:00<br/> No default value. |
| finishedDate | ✔️ Yes | Time. E.g. 2020-01-01T12:00:00+00:00<br/> No default value. |
| createdDate | ✖️ No | The time this deploy pipeline starts. E.g. 2020-01-01T12:00:00+00:00<br/> 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<br/> 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<br/> No default value. |
| environment | ✖️ No | The environment this deployment happens. For example, `PRODUCTION` `STAGING` `TESTING` `DEVELOPMENT`. <br/>The default value is `PRODUCTION` |
| result | ✖️ No | deployment result, one of the values : `SUCCESS`, `FAILURE`, `ABORT`, `MANUAL`, <br/> The default value is `SUCCESS`. |
| displayTitle | ✖️ No | A readable title for the deployment. |
Expand All @@ -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<br/> 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. |

Expand All @@ -96,6 +97,8 @@ curl <devlake-host>/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}",
Expand All @@ -104,6 +107,8 @@ curl <devlake-host>/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}",
Expand Down
11 changes: 8 additions & 3 deletions versioned_docs/version-v1.0/Plugins/webhook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<br/> No default value. |
| startedDate | ✔️ Yes | Time. E.g. 2020-01-01T12:00:00+00:00<br/> No default value. |
| finishedDate | ✔️ Yes | Time. E.g. 2020-01-01T12:00:00+00:00<br/> No default value. |
| createdDate | ✖️ No | The time this deploy pipeline starts. E.g. 2020-01-01T12:00:00+00:00<br/> 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<br/> 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<br/> No default value. |
| environment | ✖️ No | The environment this deployment happens. For example, `PRODUCTION` `STAGING` `TESTING` `DEVELOPMENT`. <br/>The default value is `PRODUCTION` |
| result | ✖️ No | deployment result, one of the values : `SUCCESS`, `FAILURE`, `ABORT`, `MANUAL`, <br/> The default value is `SUCCESS`. |
| displayTitle | ✖️ No | A readable title for the deployment. |
Expand All @@ -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<br/> 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. |

Expand All @@ -96,6 +97,8 @@ curl <devlake-host>/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}",
Expand All @@ -104,6 +107,8 @@ curl <devlake-host>/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}",
Expand Down
Loading