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/09/29 12:24:32 UTC
[incubator-devlake-website] branch main updated: revise refdiff docs
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 26be49dc9 revise refdiff docs
26be49dc9 is described below
commit 26be49dc9bb1f43a1cbb9750eacb9b2274382519
Author: zhangliang <li...@merico.dev>
AuthorDate: Thu Sep 29 20:06:00 2022 +0800
revise refdiff docs
---
docs/Plugins/refdiff.md | 37 ++++++++++++++++++-------------------
1 file changed, 18 insertions(+), 19 deletions(-)
diff --git a/docs/Plugins/refdiff.md b/docs/Plugins/refdiff.md
index bcacf95d6..ef9d1d024 100644
--- a/docs/Plugins/refdiff.md
+++ b/docs/Plugins/refdiff.md
@@ -15,29 +15,28 @@ You need to run gitextractor before the refdiff plugin. The gitextractor plugin
## Configuration
-This is a enrichment plugin based on Domain Layer data, no configuration needed
+This is an enrichment plugin based on Domain Layer data, no configuration needed
## How to use
In order to trigger the enrichment, you need to insert a new task into your pipeline.
1. Make sure `commits` and `refs` are collected into your database, `refs` table should contain records like following:
-```
-id ref_type
-github:GithubRepo:384111310:refs/tags/0.3.5 TAG
-github:GithubRepo:384111310:refs/tags/0.3.6 TAG
-github:GithubRepo:384111310:refs/tags/0.5.0 TAG
-github:GithubRepo:384111310:refs/tags/v0.0.1 TAG
-github:GithubRepo:384111310:refs/tags/v0.2.0 TAG
-github:GithubRepo:384111310:refs/tags/v0.3.0 TAG
-github:GithubRepo:384111310:refs/tags/v0.4.0 TAG
-github:GithubRepo:384111310:refs/tags/v0.6.0 TAG
-github:GithubRepo:384111310:refs/tags/v0.6.1 TAG
-```
-2. If you want to run calculateIssuesDiff, please configure GITHUB_PR_BODY_CLOSE_PATTERN in .env, you can check the example in .env.example(we have a default value, please make sure your pattern is disclosed by single quotes '')
-3. If you want to run calculatePrCherryPick, please configure GITHUB_PR_TITLE_PATTERN in .env, you can check the example in .env.example(we have a default value, please make sure your pattern is disclosed by single quotes '')
-4. And then, trigger a pipeline like following, you can also define sub tasks, calculateRefDiff will calculate commits between two ref, and creatRefBugStats will create a table to show bug list between two ref:
-```
+ ```
+ id ref_type
+ github:GithubRepo:384111310:refs/tags/0.3.5 TAG
+ github:GithubRepo:384111310:refs/tags/0.3.6 TAG
+ github:GithubRepo:384111310:refs/tags/0.5.0 TAG
+ github:GithubRepo:384111310:refs/tags/v0.0.1 TAG
+ github:GithubRepo:384111310:refs/tags/v0.2.0 TAG
+ github:GithubRepo:384111310:refs/tags/v0.3.0 TAG
+ github:GithubRepo:384111310:refs/tags/v0.4.0 TAG
+ github:GithubRepo:384111310:refs/tags/v0.6.0 TAG
+ github:GithubRepo:384111310:refs/tags/v0.6.1 TAG
+ ```
+2. If you want to run calculatePrCherryPick, please configure GITHUB_PR_TITLE_PATTERN in .env, you can check the example in .env.example(we have a default value, please make sure your pattern is disclosed by single quotes '')
+3. And then, trigger a pipeline like following, you can also define sub-tasks, calculateRefDiff will calculate commits between two ref, and creatRefBugStats will create a table to show bug list between two ref:
+```shell
curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON'
{
"name": "test-refdiff",
@@ -63,8 +62,8 @@ curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON'
}
JSON
```
-Or if you prefered calculating latest releases
-```
+Or if you preferred calculating latest releases
+```shell
curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON'
{
"name": "test-refdiff",