You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by GitBox <gi...@apache.org> on 2022/11/23 07:08:00 UTC

[GitHub] [incubator-devlake-website] abeizn opened a new pull request, #332: docs: update refdiff docs

abeizn opened a new pull request, #332:
URL: https://github.com/apache/incubator-devlake-website/pull/332

   ### ⚠️ &nbsp;&nbsp;Pre Checklist
   
   > Please complete _ALL_ items in this checklist, and remove before submitting
   
   - [ ] 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
   update refdiff docs
   
   ### Does this close any open issues?
   related to https://github.com/apache/incubator-devlake-website/pull/319
   
   ### Screenshots
   Include any relevant screenshots here.
   
   ### Other Information
   Any other information that is important to this PR.
   


-- 
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


[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #332: docs: update refdiff docs

Posted by GitBox <gi...@apache.org>.
Startrekzky commented on code in PR #332:
URL: https://github.com/apache/incubator-devlake-website/pull/332#discussion_r1032530744


##########
docs/Plugins/refdiff.md:
##########
@@ -4,10 +4,14 @@ 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.
+RefDiff is a plugin that performs calculation tasks and has 2 main purposes.
+
+- Calculate the difference in commits between releases/tags to [analyze the amount of code in each release](add an anchor link)

Review Comment:
   I added 'add an anchor link' as a placeholder for you to replace with the actual anchor link to the specific section in this doc.



-- 
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


[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #332: docs: update refdiff docs

Posted by GitBox <gi...@apache.org>.
Startrekzky commented on code in PR #332:
URL: https://github.com/apache/incubator-devlake-website/pull/332#discussion_r1030381873


##########
docs/Plugins/refdiff.md:
##########
@@ -4,10 +4,9 @@ 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 commits, and the commits are produced by Ref (branch/tag) or by deployments, and the result will be stored back into the database for further analysis.

Review Comment:
   Text change:
   RefDiff is a plugin that performs calculation tasks and has 2 main purposes.
   - Calculate the difference in commits between `releases/tags` to [analyze the amount of code in each release](add an anchor link)
   - Calculate the difference in commits between `deployments` to [calculate DORA metrics](add an anchor link)
   
   The output of RefDiff is stored in the table [refs_commits_diff](https://devlake.apache.org/docs/DataModels/DevLakeDomainLayerSchema#refs_commits_diffs).



-- 
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


[GitHub] [incubator-devlake-website] Startrekzky merged pull request #332: docs: update refdiff docs

Posted by GitBox <gi...@apache.org>.
Startrekzky merged PR #332:
URL: https://github.com/apache/incubator-devlake-website/pull/332


-- 
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


[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #332: docs: update refdiff docs

Posted by GitBox <gi...@apache.org>.
Startrekzky commented on code in PR #332:
URL: https://github.com/apache/incubator-devlake-website/pull/332#discussion_r1032533053


##########
docs/Plugins/refdiff.md:
##########
@@ -4,10 +4,14 @@ 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.
+RefDiff is a plugin that performs calculation tasks and has 2 main purposes.
+
+- Calculate the difference in commits between releases/tags to [analyze the amount of code in each release](add an anchor link)

Review Comment:
   Same as above



-- 
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


[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #332: docs: update refdiff docs

Posted by GitBox <gi...@apache.org>.
Startrekzky commented on code in PR #332:
URL: https://github.com/apache/incubator-devlake-website/pull/332#discussion_r1030383399


##########
docs/Plugins/refdiff.md:
##########
@@ -4,10 +4,9 @@ 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 commits, and the commits are produced by Ref (branch/tag) or by deployments, and the result will be stored back into the database for further analysis.
 
 ## Important Note

Review Comment:
   How to use RefDiff to calculate commits diff between releases/tags



-- 
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