This is an automated email from the ASF dual-hosted git repository.
klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 840cb4c1ff Fixes ambiguity on environment key values (#713)
840cb4c1ff is described below
commit 840cb4c1ff3a4fe5495a39629f4da829aec16ee5
Author: Joe Salisbury <[email protected]>
AuthorDate: Fri Feb 9 05:50:38 2024 +0000
Fixes ambiguity on environment key values (#713)
---
docs/Plugins/webhook.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/Plugins/webhook.md b/docs/Plugins/webhook.md
index 3b35d4ca74..64513dcb6e 100644
--- a/docs/Plugins/webhook.md
+++ b/docs/Plugins/webhook.md
@@ -54,7 +54,7 @@ You can copy the generated deployment curl commands to your
CI/CD script to post
| Key | Required | Notes
|
| :---------: | :------: |
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
| pipeline_id | ✖️ No | related Domain Layer `cicd_pipelines.id`
|
-| environment | ✖️ No | the environment this deployment happens. For
example, `PRODUCTION` `STAGING` `TESTING` `DEVELOPMENT`. <br/>The default value
is `PRODUCTION` |
+| environment | ✖️ No | the environment this deployment happens, one of the
values: `PRODUCTION`, `STAGING`, `TESTING`, `DEVELOPMENT`. <br/>The default
value is `PRODUCTION`. |
| repo_url | ✔️ Yes | the repo URL of the deployment commit<br />If there
is a row in the domain layer table `repos` where `repos.url` equals `repo_url`,
the `repoId` will be filled with `repos.id`. |
| repo_id | ✖️ No | related Domain Layer `repos.id` <br/> No default
value.
|
| name | ✖️ No | deployment name. The default value is "deployment
for `request.commit_sha`"
|
@@ -64,7 +64,7 @@ You can copy the generated deployment curl commands to your
CI/CD script to post
| create_time | ✖️ No | Time. Eg. 2020-01-01T12:00:00+00:00<br/> No default
value.
|
| start_time | ✔️ Yes | Time. Eg. 2020-01-01T12:00:00+00:00<br/> No default
value.
|
| end_time | ✖️ No | Time. Eg. 2020-01-01T12:00:00+00:00<br/> The
default value is the time when DevLake receives the POST request.
|
-| result | ✖️ No | deployment result, one of the values : `SUCCESS`,
`FAILURE`, `ABORT`, `MANUAL`, <br/> The default value is `SUCCESS`.
|
+| result | ✖️ No | deployment result, one of the values: `SUCCESS`,
`FAILURE`, `ABORT`, `MANUAL`. <br/> The default value is `SUCCESS`.
|
| deploymentCommits[] | ✖️ yes | Allow deployment webhook to push
deployments to multiple repos in one request, includes
repo_url,commit_sha,commit_msg,name,ref_name |
