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 ea568f1e19d3b2848c457ba4658e8919ca2b186f Author: abeizn <[email protected]> AuthorDate: Mon Nov 28 16:39:14 2022 +0800 docs: update refdiff docs --- docs/Plugins/refdiff.md | 6 +- .../domain_layer_model_v0.14.ndm2 | 166 ++++++++++----------- static/img/DomainLayerSchema/schema-diagram.png | Bin 503846 -> 503803 bytes 3 files changed, 86 insertions(+), 86 deletions(-) diff --git a/docs/Plugins/refdiff.md b/docs/Plugins/refdiff.md index 53ec882c2..5e86ff6c7 100644 --- a/docs/Plugins/refdiff.md +++ b/docs/Plugins/refdiff.md @@ -8,8 +8,8 @@ description: > 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) +- Calculate the difference in commits between releases/tags to [analyze the amount of code in each release](https://github.com/apache/incubator-devlake/blob/main/plugins/refdiff/tasks/commit_diff_calculator.go) +- Calculate the difference in commits between deployments to [calculate DORA metrics](https://github.com/apache/incubator-devlake/blob/main/plugins/refdiff/tasks/project_deployment_commit_diff_calculator.go) And the output of RefDiff is stored in the table commits_diffs, finished_commits_diffs, ref_commits. @@ -39,7 +39,7 @@ To trigger the enrichment, you need to insert a new task into your pipeline. github:GithubRepo:1: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: +3. And then, trigger a pipeline like the following format: ```shell curl 'http://localhost:8080/pipelines' \ diff --git a/static/img/DomainLayerSchema/domain_layer_model_v0.14.ndm2 b/static/img/DomainLayerSchema/domain_layer_model_v0.14.ndm2 index 197f3d1b9..72654c5f7 100644 --- a/static/img/DomainLayerSchema/domain_layer_model_v0.14.ndm2 +++ b/static/img/DomainLayerSchema/domain_layer_model_v0.14.ndm2 @@ -10019,7 +10019,7 @@ }, { "objectType": "Table_MYSQL", - "name": "ref_commits", + "name": "finished_commits_diffs", "comment": "", "engine": "", "characterSet": "", @@ -10118,58 +10118,6 @@ "virtualExpr": "", "virtualType": "", "oldName": "old_commit_sha" - }, - { - "objectType": "TableField_MYSQL", - "name": "new_ref_id", - "type": "char", - "length": 255, - "decimals": -2147483648, - "isUnsigned": false, - "isZeroFill": false, - "setEnumValues": "", - "isBinary": false, - "charset": "", - "collation": "", - "isNullable": false, - "defaultType": "Others", - "defaultValue": "", - "isOnUpdateCurrentTimestamp": false, - "isAutoInc": false, - "comment": "", - "columnFormat": "", - "storage": "", - "isVirtual": false, - "isGeneratedAlways": false, - "virtualExpr": "", - "virtualType": "", - "oldName": "new_ref_id" - }, - { - "objectType": "TableField_MYSQL", - "name": "olde_red_id", - "type": "char", - "length": 255, - "decimals": -2147483648, - "isUnsigned": false, - "isZeroFill": false, - "setEnumValues": "", - "isBinary": false, - "charset": "", - "collation": "", - "isNullable": false, - "defaultType": "Others", - "defaultValue": "", - "isOnUpdateCurrentTimestamp": false, - "isAutoInc": false, - "comment": "", - "columnFormat": "", - "storage": "", - "isVirtual": false, - "isGeneratedAlways": false, - "virtualExpr": "", - "virtualType": "", - "oldName": "olde_red_id" } ], "indexes": [], @@ -10179,14 +10127,14 @@ "fields": [ { "objectType": "IndexField_MYSQL", - "name": "new_ref_id", + "name": "new_commit_sha", "keyLength": 0, "order": "", "oldName": "" }, { "objectType": "IndexField_MYSQL", - "name": "olde_red_id", + "name": "old_commit_sha", "keyLength": 0, "order": "", "oldName": "" @@ -10199,12 +10147,12 @@ "foreignKeys": [ { "objectType": "ForeignKey_MYSQL", - "name": "fk_ref_commits_ref_commits_1", + "name": "fk_commits_diffs_status_commits_diffs_status_1", "fields": [ "new_commit_sha" ], "referenceSchema": "Default", - "referenceTable": "finished_commits_diffs", + "referenceTable": "commits_diffs", "referenceFields": [ "new_commit_sha" ], @@ -10216,12 +10164,12 @@ }, { "objectType": "ForeignKey_MYSQL", - "name": "fk_ref_commits_ref_commits_2", + "name": "fk_commits_diffs_status_commits_diffs_status_2", "fields": [ "old_commit_sha" ], "referenceSchema": "Default", - "referenceTable": "finished_commits_diffs", + "referenceTable": "commits_diffs", "referenceFields": [ "old_commit_sha" ], @@ -10230,6 +10178,23 @@ "sourceCardinality": "NoneRelationship", "targetCardinality": "NoneRelationship", "oldName": "" + }, + { + "objectType": "ForeignKey_MYSQL", + "name": "fk_commits_diffs_status_commits_diffs_status_3", + "fields": [ + "old_commit_sha" + ], + "referenceSchema": "lake", + "referenceTable": "cicd_pipeline_commits", + "referenceFields": [ + "commit_sha" + ], + "onDelete": "", + "onUpdate": "", + "sourceCardinality": "NoneRelationship", + "targetCardinality": "NoneRelationship", + "oldName": "" } ], "checks": [], @@ -10238,7 +10203,7 @@ }, { "objectType": "Table_MYSQL", - "name": "finished_commits_diffs", + "name": "ref_commits", "comment": "", "engine": "", "characterSet": "", @@ -10337,6 +10302,58 @@ "virtualExpr": "", "virtualType": "", "oldName": "old_commit_sha" + }, + { + "objectType": "TableField_MYSQL", + "name": "new_ref_id", + "type": "char", + "length": 255, + "decimals": -2147483648, + "isUnsigned": false, + "isZeroFill": false, + "setEnumValues": "", + "isBinary": false, + "charset": "", + "collation": "", + "isNullable": false, + "defaultType": "Others", + "defaultValue": "", + "isOnUpdateCurrentTimestamp": false, + "isAutoInc": false, + "comment": "", + "columnFormat": "", + "storage": "", + "isVirtual": false, + "isGeneratedAlways": false, + "virtualExpr": "", + "virtualType": "", + "oldName": "new_ref_id" + }, + { + "objectType": "TableField_MYSQL", + "name": "old_ref_id", + "type": "char", + "length": 255, + "decimals": -2147483648, + "isUnsigned": false, + "isZeroFill": false, + "setEnumValues": "", + "isBinary": false, + "charset": "", + "collation": "", + "isNullable": false, + "defaultType": "Others", + "defaultValue": "", + "isOnUpdateCurrentTimestamp": false, + "isAutoInc": false, + "comment": "", + "columnFormat": "", + "storage": "", + "isVirtual": false, + "isGeneratedAlways": false, + "virtualExpr": "", + "virtualType": "", + "oldName": "old_ref_id" } ], "indexes": [], @@ -10346,14 +10363,14 @@ "fields": [ { "objectType": "IndexField_MYSQL", - "name": "new_commit_sha", + "name": "new_ref_id", "keyLength": 0, "order": "", "oldName": "" }, { "objectType": "IndexField_MYSQL", - "name": "old_commit_sha", + "name": "old_ref_id", "keyLength": 0, "order": "", "oldName": "" @@ -10366,12 +10383,12 @@ "foreignKeys": [ { "objectType": "ForeignKey_MYSQL", - "name": "fk_commits_diffs_status_commits_diffs_status_1", + "name": "fk_ref_commits_ref_commits_1", "fields": [ "new_commit_sha" ], "referenceSchema": "Default", - "referenceTable": "commits_diffs", + "referenceTable": "finished_commits_diffs", "referenceFields": [ "new_commit_sha" ], @@ -10383,12 +10400,12 @@ }, { "objectType": "ForeignKey_MYSQL", - "name": "fk_commits_diffs_status_commits_diffs_status_2", + "name": "fk_ref_commits_ref_commits_2", "fields": [ "old_commit_sha" ], "referenceSchema": "Default", - "referenceTable": "commits_diffs", + "referenceTable": "finished_commits_diffs", "referenceFields": [ "old_commit_sha" ], @@ -10397,23 +10414,6 @@ "sourceCardinality": "NoneRelationship", "targetCardinality": "NoneRelationship", "oldName": "" - }, - { - "objectType": "ForeignKey_MYSQL", - "name": "fk_commits_diffs_status_commits_diffs_status_3", - "fields": [ - "old_commit_sha" - ], - "referenceSchema": "lake", - "referenceTable": "cicd_pipeline_commits", - "referenceFields": [ - "commit_sha" - ], - "onDelete": "", - "onUpdate": "", - "sourceCardinality": "NoneRelationship", - "targetCardinality": "NoneRelationship", - "oldName": "" } ], "checks": [], diff --git a/static/img/DomainLayerSchema/schema-diagram.png b/static/img/DomainLayerSchema/schema-diagram.png index af04b66e5..fa50e1d4b 100644 Binary files a/static/img/DomainLayerSchema/schema-diagram.png and b/static/img/DomainLayerSchema/schema-diagram.png differ
