You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by yu...@apache.org on 2022/10/14 09:06:30 UTC
[incubator-devlake-website] branch main updated: docs: update wording for dora and webhook
This is an automated email from the ASF dual-hosted git repository.
yumeng 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 d3899479c docs: update wording for dora and webhook
d3899479c is described below
commit d3899479c8331b2c99bd51aa49c4b2de405cc7ef
Author: Startrekzky <ka...@merico.dev>
AuthorDate: Fri Oct 14 16:58:29 2022 +0800
docs: update wording for dora and webhook
---
docs/Plugins/webhook.md | 4 ++--
docs/UserManuals/DORA.md | 6 ++----
2 files changed, 4 insertions(+), 6 deletions(-)
diff --git a/docs/Plugins/webhook.md b/docs/Plugins/webhook.md
index 0af51e209..897de7a1b 100644
--- a/docs/Plugins/webhook.md
+++ b/docs/Plugins/webhook.md
@@ -39,7 +39,7 @@ You can copy the generated deployment curl commands to your CI/CD script to post
### Deployment - Sample API Calls
-Sample CURL to post deployments to DevLake. The URL `https://sample-url.com/api/plugins/webhook/1/deployments` should be replaced with the actual URL copied from your Config UI:
+Sample CURL to post deployments to DevLake. The following command should be replaced with the actual curl command copied from your Config UI:
```
curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -d '{
@@ -51,7 +51,7 @@ curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -d '{
}'
```
-If you have set a username/password for Config UI, you need to add the username and password to the following curl to register a `deployment`:
+If you have set a [username/password](https://devlake.apache.org/docs/UserManuals/Authentication) for Config UI, you'll need to add them to the curl command to register a `deployment`:
```
curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -u 'username:password' -d '{
"commit_sha":"015e3d3b480e417aede5a1293bd61de9b0fd051d",
diff --git a/docs/UserManuals/DORA.md b/docs/UserManuals/DORA.md
index 55d3bd183..9ea594358 100644
--- a/docs/UserManuals/DORA.md
+++ b/docs/UserManuals/DORA.md
@@ -101,7 +101,7 @@ Using CircleCI as an example, we demonstrate how to actively push data to DevLak
9. Now head to your CircleCI's pipelines page in a new tab. Find your deployment pipeline and click `Configuration File`
-10. Paste the curl command copied in step 8 to the `config.yml`.
+10. Paste the curl command copied in step 8 to the `config.yml`, change the key-values in the payload. See full payload schema [here](https://devlake.apache.org/docs/Plugins/webhook/##register-a-deployment).
```
version: 2.1
@@ -144,7 +144,7 @@ Using CircleCI as an example, we demonstrate how to actively push data to DevLak
- build
- deploy
```
- If you have set a [username/password](https://devlake.apache.org/docs/UserManuals/Authentication) for Config UI, you need to add the username and password to the curl to register a deployment:
+ If you have set a [username/password](https://devlake.apache.org/docs/UserManuals/Authentication) for Config UI, you need to add them to the curl to register a deployment:
```
curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -u 'username:password' -d '{
@@ -154,8 +154,6 @@ Using CircleCI as an example, we demonstrate how to actively push data to DevLak
}'
```
- You can find more about webhook's payload schema in this [doc](https://devlake.apache.org/docs/Plugins/webhook/#deployments).
-
11. Run the modified CircleCI pipeline. Check to verify that the request has been successfully sent.
