Startrekzky commented on code in PR #328: URL: https://github.com/apache/incubator-devlake-website/pull/328#discussion_r1025124802
########## docs/Plugins/refdiff.md: ########## @@ -138,30 +144,33 @@ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib64 [ubuntu] export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib:/usr/local/lib/pkgconfig export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib + ``` -#### Troubleshooting (Linux) +#### Troubleshooting (linux) -> Q: # pkg-config --cflags -- libgit2 Package libgit2 was not found in the pkg-config search path. -Perhaps you should add the directory containing `libgit2.pc` to the PKG_CONFIG_PATH environment variable -No package 'libgit2' found pkg-config: exit status 1 +> Q: # pkg-config --cflags -- libgit2 Package libgit2 was not found in the pkg-config search path. +> Perhaps you should add the directory containing `libgit2.pc` to the PKG_CONFIG_PATH environment variable +> No package 'libgit2' found pkg-config: exit status 1 > A: > Make sure your pkg config path covers the installation: > if your libgit2.pc in `/usr/local/lib64/pkgconfig`(like centos) -> +> > `export > PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib64:/usr/local/lib64/pkgconfig` -> +> > else if your libgit2.pc in `/usr/local/lib/pkgconfig`(like ubuntu) -> +> > `export > PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib:/usr/local/lib/pkgconfig` -> +> > else consider install pkgconfig or rebuild the libgit2 ### MacOS -NOTE: **Do NOT** install libgit2 via `MacPorts` or `homebrew`, install from source instead. +NOTEļ¼Do **NOT** install libgit2 via `MacPorts` or `homebrew`, install from source instead. Review Comment: Use **Do NOT** ########## docs/Plugins/refdiff.md: ########## @@ -4,40 +4,42 @@ description: > RefDiff Plugin --- - ## Summary -For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into the database for further analysis. +For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into database for further analysis. ## Important Note -You need to run `gitextractor` before the `refdiff` plugin. The `gitextractor` plugin should create records in the `refs` table in your database before this plugin can be run. Review Comment: please use the original wording ########## docs/Plugins/refdiff.md: ########## @@ -4,40 +4,42 @@ description: > RefDiff Plugin --- - ## Summary -For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into the database for further analysis. Review Comment: please use the original wording ########## docs/Plugins/refdiff.md: ########## @@ -109,27 +114,28 @@ curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON' } ] ] -} +}' ``` ## Development -This plugin depends on `libgit2`, you need to install version 1.3.0 to run and debug this plugin on your local +This plugin depends on `libgit2`, you need to install version 1.3.0 in order to run and debug this plugin on your local Review Comment: use 'to' ########## docs/Plugins/refdiff.md: ########## @@ -4,40 +4,42 @@ description: > RefDiff Plugin --- - ## Summary -For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into the database for further analysis. +For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into database for further analysis. ## Important Note -You need to run `gitextractor` before the `refdiff` plugin. The `gitextractor` plugin should create records in the `refs` table in your database before this plugin can be run. +You need to run gitextractor before the refdiff plugin. The gitextractor plugin should create records in the `refs` table in your DB before this plugin can be run. ## Configuration -This is an enrichment plugin based on the domain layer data, no configuration is needed. +This is an enrichment plugin based on Domain Layer data, no configuration needed -## How to use refdiff +## How to use -To trigger the enrichment, you need to insert a new task into your pipeline. +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 - ``` + ``` + 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 the following format, you can also define sub-tasks, calculateRefDiff will calculate commits between two refs, and creatRefBugStats will create a table to show a bug list between two refs: -```shell -curl -v -XPOST http://localhost:8080/pipelines --data @- <<'JSON' +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: Review Comment: please use the original wording ########## docs/Plugins/refdiff.md: ########## @@ -4,40 +4,42 @@ description: > RefDiff Plugin --- - ## Summary -For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into the database for further analysis. +For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into database for further analysis. ## Important Note -You need to run `gitextractor` before the `refdiff` plugin. The `gitextractor` plugin should create records in the `refs` table in your database before this plugin can be run. +You need to run gitextractor before the refdiff plugin. The gitextractor plugin should create records in the `refs` table in your DB before this plugin can be run. ## Configuration -This is an enrichment plugin based on the domain layer data, no configuration is needed. +This is an enrichment plugin based on Domain Layer data, no configuration needed -## How to use refdiff +## How to use -To trigger the enrichment, you need to insert a new task into your pipeline. +In order to trigger the enrichment, you need to insert a new task into your pipeline. Review Comment: please use the original wording ########## docs/Plugins/refdiff.md: ########## @@ -4,40 +4,42 @@ description: > RefDiff Plugin --- - ## Summary -For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into the database for further analysis. +For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into database for further analysis. ## Important Note -You need to run `gitextractor` before the `refdiff` plugin. The `gitextractor` plugin should create records in the `refs` table in your database before this plugin can be run. +You need to run gitextractor before the refdiff plugin. The gitextractor plugin should create records in the `refs` table in your DB before this plugin can be run. ## Configuration -This is an enrichment plugin based on the domain layer data, no configuration is needed. +This is an enrichment plugin based on Domain Layer data, no configuration needed -## How to use refdiff +## How to use Review Comment: please use the original wording ########## docs/Plugins/refdiff.md: ########## @@ -4,40 +4,42 @@ description: > RefDiff Plugin --- - ## Summary -For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into the database for further analysis. +For development workload analysis, we often need to know how many commits have been created between 2 releases. This plugin calculates which commits differ between 2 Ref (branch/tag), and the result will be stored back into database for further analysis. ## Important Note -You need to run `gitextractor` before the `refdiff` plugin. The `gitextractor` plugin should create records in the `refs` table in your database before this plugin can be run. +You need to run gitextractor before the refdiff plugin. The gitextractor plugin should create records in the `refs` table in your DB before this plugin can be run. ## Configuration -This is an enrichment plugin based on the domain layer data, no configuration is needed. Review Comment: please use the original wording ########## docs/Plugins/refdiff.md: ########## @@ -138,30 +144,33 @@ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib64 [ubuntu] export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib:/usr/local/lib/pkgconfig export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib + ``` -#### Troubleshooting (Linux) +#### Troubleshooting (linux) Review Comment: use Linux -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
