[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #253: docs: add authorization setting for dora webhook

[GitBox <gi...@apache.org>]

Startrekzky commented on code in PR #253:
URL: https://github.com/apache/incubator-devlake-website/pull/253#discussion_r995288277


##########
docs/UserManuals/DORA.md:
##########
@@ -132,7 +132,10 @@ Using CircleCI as an example, we demonstrate how to actively push data to DevLak
 
               # Send the request to DevLake after deploy
               # The values start with a '$CIRCLE_' are CircleCI's built-in variables
-              curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -d "{
+              curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' \

Review Comment:
   Just use 'username/password' is OK. For example,
   
   curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -u 'username:password' -d '{
       ...
       ...



##########
docs/UserManuals/DORA.md:
##########
@@ -144,6 +147,14 @@ Using CircleCI as an example, we demonstrate how to actively push data to DevLak
         - build
         - deploy
   ```
+  If you do not setting the config-ui username and password, you can ignore the line `--header 'authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='`
+
+  Else you have to find out an base64 encode tool to caculate the base64 of your `username:password`:
+
+  ![](base64.jpg)
+
+  And after you caculated your `username:password` base64 coding.You have to use your base64 coding to replace `dXNlcm5hbWU6cGFzc3dvcmQ=`.

Review Comment:
   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\"
     }'
   ```
   
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org