You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by zk...@apache.org on 2022/11/14 12:38:27 UTC

[incubator-devlake-website] 03/04: docs: use refdiff with dora

This is an automated email from the ASF dual-hosted git repository.

zky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git

commit f83ae3aa6025ff71cfdd7175bf3cf716c841ee9b
Author: abeizn <zi...@merico.dev>
AuthorDate: Mon Oct 31 14:08:06 2022 +0800

    docs: use refdiff with dora
---
 .github/pull_request_template.md | 2 +-
 docs/Plugins/refdiff.md          | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index e4cd48068..d0836ddf3 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -2,7 +2,7 @@
 
 > Please complete _ALL_ items in this checklist, and remove before submitting
 
-- [ ] I have `run npm build` and `run npm serve` locally before submitting this PR
+- [ ] I have `npm run build` and `npm run serve` locally before submitting this PR
 - [ ] I have read through the [Contributing](https://devlake.apache.org/community/) Documentation
 
 # Summary
diff --git a/docs/Plugins/refdiff.md b/docs/Plugins/refdiff.md
index ba5dded9d..bae13bd55 100644
--- a/docs/Plugins/refdiff.md
+++ b/docs/Plugins/refdiff.md
@@ -89,8 +89,8 @@ curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON'
 JSON
 ```
 
-## How to use with dora 
-Refdiff take the project_name from taskOptions, and offer the ability to calculate refs_commits_diffs between 2 consecutive deployments under the same scope.
+## How it gets used in DORA
+RefDiff can be called by the [DORA plugin](https://github.com/apache/incubator-devlake/tree/main/plugins/dora). RefDiff takes the project_name from taskOptions to calculate refs_commits_diffs between two consecutive deployments within the same project.
  
 ```shell
 curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON'