You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by li...@apache.org on 2023/03/07 10:00:16 UTC
[incubator-devlake-website] 01/01: fix: update doc for new logic in repo id
This is an automated email from the ASF dual-hosted git repository.
likyh pushed a commit to branch issues/4599
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit 8bae9848fde1dc478c8a29ac963a08603fc7a19e
Author: linyh <ya...@meri.co>
AuthorDate: Tue Mar 7 18:00:04 2023 +0800
fix: update doc for new logic in repo id
---
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