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:24 UTC

[incubator-devlake-website] branch main updated (a25b2584e -> 9f0811c3a)

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

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


    from a25b2584e remove cicd_pipeline_relationships
     new 110ae1443 docs: use refdiff with dora
     new 574d76921 docs: use refdiff with dora
     new f83ae3aa6 docs: use refdiff with dora
     new 9f0811c3a docs: use refdiff with dora

The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .github/pull_request_template.md |  2 +-
 docs/Plugins/refdiff.md          | 22 ++++++++++++++++++++++
 2 files changed, 23 insertions(+), 1 deletion(-)


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

Posted by zk...@apache.org.
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 110ae1443eb1937431cb917e0264e7bb6c3284b2
Author: abeizn <zi...@merico.dev>
AuthorDate: Fri Oct 28 17:02:01 2022 +0800

    docs: use refdiff with dora
---
 docs/Plugins/refdiff.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/docs/Plugins/refdiff.md b/docs/Plugins/refdiff.md
index f84716309..5e58c552b 100644
--- a/docs/Plugins/refdiff.md
+++ b/docs/Plugins/refdiff.md
@@ -89,6 +89,30 @@ 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.
+ 
+```shell
+curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON'
+{
+    "name": "test-refdiff-dora",
+    "tasks": [
+        [
+            {
+                "plugin": "refdiff",
+                "options": {
+                    "projectName": "xxxx",
+                    "scopeId": "github:GithubRepo:384111310",
+                    "tasks": [
+                        "calculateCommitsDiff"
+                    ]
+                }
+            }
+        ]
+    ]
+}
+```
+
 ## Development
 
 This plugin depends on `libgit2`, you need to install version 1.3.0 in order to run and debug this plugin on your local


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

Posted by zk...@apache.org.
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 574d769219d80980c115764c6768995829ca3097
Author: abeizn <zi...@merico.dev>
AuthorDate: Fri Oct 28 20:18:54 2022 +0800

    docs: use refdiff with dora
---
 docs/Plugins/refdiff.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/docs/Plugins/refdiff.md b/docs/Plugins/refdiff.md
index 5e58c552b..ba5dded9d 100644
--- a/docs/Plugins/refdiff.md
+++ b/docs/Plugins/refdiff.md
@@ -102,7 +102,6 @@ curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON'
                 "plugin": "refdiff",
                 "options": {
                     "projectName": "xxxx",
-                    "scopeId": "github:GithubRepo:384111310",
                     "tasks": [
                         "calculateCommitsDiff"
                     ]


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

Posted by zk...@apache.org.
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'


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

Posted by zk...@apache.org.
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 9f0811c3a45551a4dad1bd4320663c4d9d1ff5dc
Author: abeizn <zi...@merico.dev>
AuthorDate: Mon Oct 31 17:54:54 2022 +0800

    docs: use refdiff with dora
---
 docs/Plugins/refdiff.md | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/docs/Plugins/refdiff.md b/docs/Plugins/refdiff.md
index bae13bd55..93a6cff8d 100644
--- a/docs/Plugins/refdiff.md
+++ b/docs/Plugins/refdiff.md
@@ -89,8 +89,7 @@ curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON'
 JSON
 ```
 
-## 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.
+4. Refdiff has a new subtask `calculateProjectDeploymentCommitsDiff`, which can find related deployments according to the project, and then calculate the commits diff between deployments. Such a function can be used to support the calculation of dora indicators.
  
 ```shell
 curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON'
@@ -103,7 +102,7 @@ curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON'
                 "options": {
                     "projectName": "xxxx",
                     "tasks": [
-                        "calculateCommitsDiff"
+                        "calculateProjectDeploymentCommitsDiff"
                     ]
                 }
             }