This is an automated email from the ASF dual-hosted git repository.
likyh 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 e4475d078a fix: update doc for new logic in repo id (#459)
e4475d078a is described below
commit e4475d078a2dd0aa824860cb6e899a52595ffe94
Author: Likyh <[email protected]>
AuthorDate: Tue Mar 7 18:08:07 2023 +0800
fix: update doc for new logic in repo id (#459)
---
docs/Plugins/webhook.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/docs/Plugins/webhook.md b/docs/Plugins/webhook.md
index 0276c627ee..370d3895b9 100644
--- a/docs/Plugins/webhook.md
+++ b/docs/Plugins/webhook.md
@@ -45,13 +45,13 @@ If you want to collect deployment data from your system,
you can use the incomin
You can copy the generated deployment curl commands to your CI/CD script to
post deployments to Apache DevLake. Below is the detailed payload schema:
-| Key | Required | Notes
|
-| :---------: | :------: |
--------------------------------------------------------------------------------------------------------------------------------------------
|
-| commit_sha | ✔️ Yes | the sha of the deployment commit
|
-| repo_url | ✔️ Yes | the repo URL of the deployment commit
|
-| environment | ✖️ No | the environment this deployment happens. For
example, `PRODUCTION` `STAGING` `TESTING` `DEVELOPMENT`. <br/>The default value
is `PRODUCTION` |
-| start_time | ✖️ No | 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.
|
+| Key | Required | Notes
|
+| :---------: | :------: |
------------------------------------------------------------ |
+| commit_sha | ✔️ Yes | the sha of the deployment commit
|
+| 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`. |
+| environment | ✖️ No | the environment this deployment happens. For
example, `PRODUCTION` `STAGING` `TESTING` `DEVELOPMENT`. <br/>The default value
is `PRODUCTION` |
+| start_time | ✖️ No | 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. |
#### Register a Deployment - Sample API Calls