This is an automated email from the ASF dual-hosted git repository.
mappjzc 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 b6719a8d1 docs: add authorization setting for dora webhook (#253)
b6719a8d1 is described below
commit b6719a8d1533644661bd3a4c87ba44741ec70f87
Author: mappjzc <[email protected]>
AuthorDate: Fri Oct 14 14:05:29 2022 +0800
docs: add authorization setting for dora webhook (#253)
* docs: add authorization setting for dora webhook
Add header for webhook dora curl
Add doc to show how to caculate authorization: Basic
Nddtfjiang <[email protected]>
* Update Dora.md
fix merge error
* Update DORA.md
* docs: header change
change header to be -u to set username and password.
Nddtfjiang <[email protected]>
---
docs/UserManuals/DORA.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/docs/UserManuals/DORA.md b/docs/UserManuals/DORA.md
index 8fef31e5c..55d3bd183 100644
--- a/docs/UserManuals/DORA.md
+++ b/docs/UserManuals/DORA.md
@@ -144,6 +144,16 @@ 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:
+
+ ```
+ curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -u
'username:password' -d '{
+ \"commit_sha\":\"$CIRCLE_SHA1\",
+ \"repo_url\":\"$CIRCLE_REPOSITORY_URL\",
+ \"start_time\":\"$start_time\"
+ }'
+ ```
+
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.
