You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by "Startrekzky (via GitHub)" <gi...@apache.org> on 2023/09/19 10:47:03 UTC
[GitHub] [incubator-devlake-website] Startrekzky opened a new pull request, #640: docs: update CICD models' description
Startrekzky opened a new pull request, #640:
URL: https://github.com/apache/incubator-devlake-website/pull/640
### ⚠️ Pre Checklist
> Please complete _ALL_ items in this checklist, and remove before submitting
- [x] I have `npm run build` and `npm run serve` locally before submitting this PR
- [x] I have read through the [Contributing](https://devlake.apache.org/community/) Documentation
# Summary
Update the description of the records in the CI/CD domain tables. For instance:
1. Add Bamoo entities as examples
2. Update the description for fields with hidden(default) data conversion, e.g. `type`, `status`, `type`, `environment`, etc.
3. Fix the wrong description in table.cicd_pipelines
4. Clarify the description of `prev_success_deployment_commit_id` in table.cicd_deployment_commits
5. and many other changes
All changes are made on main, v0.19 and v0.18 docs.
<!--
Thanks for submitting a PR! We appreciate you spending the time to work on these changes. Please fill out as many sections below as possible.
-->
### Does this close any open issues?
N/A
### Screenshots
N/A
--
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] d4x1 commented on a diff in pull request #640: docs: update CICD models' description
Posted by "d4x1 (via GitHub)" <gi...@apache.org>.
d4x1 commented on code in PR #640:
URL: https://github.com/apache/incubator-devlake-website/pull/640#discussion_r1329989926
##########
docs/DataModels/DevLakeDomainLayerSchema.md:
##########
@@ -441,36 +441,37 @@ Normal comments, review bodies, reviews' inline comments of GitHub's pull reques
#### cicd_scopes
-The entity to filter or group 'cicd_pipelines' or 'cicd_tasks'.
+The entity to filter or group 'cicd_pipelines'.
- For GitHub: a GitHub repo is converted to a cicd_scope
- For GitLab: a GitLab project is converted to a cicd_scope
- For Jenkins: a Jenkins job is converted to a cicd_scope
+- For Bamboo CI: a Bamboo plan is converted to a cicd_scope
| **field** | **type** | **length** | **description** | **key** |
| :------------- | :------- | :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ |
-| `id` | varchar | 255 | A cicd_scope's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..."<br/>For example, a Github cicd_scope's id is like "< github >:< GithubRepos >:< ConnectionId >:< GithubRepoId >". E.g. 'github:GithubRepos:1:384111310' | PK |
+| `id` | varchar | 255 | A cicd_scope's `id` is composed of "< plugin >:< Entity >:< PluginConnectionId >[:PK1]..."<br/>For example, a GitHub cicd_scope's id is "github:GithubRepos:< GithubConnectionId >:< GithubRepoId >", a Bamboo cicd_scope's id is 'bamboo:BambooPlan:< BambooConnectionId >:< BambooPlanKey >' | PK |
| `name` | varchar | 255 | The name of cicd_scope. | |
| `description` | longtext | | The description of cicd_scope. | |
| `url` | varchar | 255 | The url of cicd_scope. E.g. https://github.com/apache/incubator-devlake or https://jenkins.xxx.cn/view/PROD/job/OPS_releasev2/ | |
-| `created_date` | datetime | 3 | cicd_scope creation date | |
-| `updated_date` | datetime | 3 | Date of the last data collection for this cicd_scope | |
+| `created_date` | datetime | 3 | Creation date of the cicd_scope, nullable | |
+| `updated_date` | datetime | 3 | Updation date of the cicd_scope, nullable | |
#### cicd_pipelines
-A cicd_pipeline is a series of cicd_tasks, e.g. a GitHub workflow run, a GitLab pipeline, a BitBucket pipeline, a Jenkins build, etc.
+A cicd_pipeline is the abstraction of a top-level CI/CD execution, e.g. a GitHub workflow run, a GitLab pipeline, a BitBucket pipeline, a Jenkins build, a Bamboo plan build, etc. A cicd_pipeline contains one or more of cicd_tasks.
| **field** | **type** | **length** | **description** | **key** |
| :-------------- | :-------------- | :--------- | :-------------------------------------------------------------------------------------------- | :---------------- |
| `id` | varchar | 255 | This key is generated based on details from the original plugin | PK |
| `name` | varchar | 255 | For gitlab, as there is no name for pipeline, so we use projectId, others have their own name | |
-| `result` | varchar | 100 | The result of this task, e.g. SUCCESS, FAILURE | |
-| `status` | varchar | 100 | The status of this task, e.g. IN_PROGRESS, DONE | |
-| `type` | varchar | 100 | To indicate if this is a DEPLOYMENT | |
-| `duration_sec` | bigint unsigned | | how long does this task take | |
-| `created_date` | datetime | 3 | when did this task start | |
-| `finished_date` | datetime | 3 | when did this task finish | |
-| `environment` | varchar | 255 | To indicate the environment in which the task is running | |
+| `result` | varchar | 100 | The result of the pipeline. It will be standardized to 'SUCCESS', 'FAILURE' in DevLake based on each plugin's possible results. | |
+| `status` | varchar | 100 | The status of the pipeline. It will be standardized to 'DONE', 'IN_PROGRESS' in DevLake based on each plugin's possible statues. |
+| `type` | varchar | 100 | The value will be set to 'DEPLOYMENT' if it matched the ReGex configured in the Scope Config, otherwise it is an empty string. | |
+| `environment` | varchar | 255 | The value will be set to 'PRODUCTION' if it matched the ReGex configured in the Scope Config, otherwise it is an empty string. | |
Review Comment:
I think `ReGex` should be `regex`, https://en.wikipedia.org/wiki/Regular_expression
##########
docs/DataModels/DevLakeDomainLayerSchema.md:
##########
@@ -441,36 +441,37 @@ Normal comments, review bodies, reviews' inline comments of GitHub's pull reques
#### cicd_scopes
-The entity to filter or group 'cicd_pipelines' or 'cicd_tasks'.
+The entity to filter or group 'cicd_pipelines'.
- For GitHub: a GitHub repo is converted to a cicd_scope
- For GitLab: a GitLab project is converted to a cicd_scope
- For Jenkins: a Jenkins job is converted to a cicd_scope
+- For Bamboo CI: a Bamboo plan is converted to a cicd_scope
| **field** | **type** | **length** | **description** | **key** |
| :------------- | :------- | :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ |
-| `id` | varchar | 255 | A cicd_scope's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..."<br/>For example, a Github cicd_scope's id is like "< github >:< GithubRepos >:< ConnectionId >:< GithubRepoId >". E.g. 'github:GithubRepos:1:384111310' | PK |
+| `id` | varchar | 255 | A cicd_scope's `id` is composed of "< plugin >:< Entity >:< PluginConnectionId >[:PK1]..."<br/>For example, a GitHub cicd_scope's id is "github:GithubRepos:< GithubConnectionId >:< GithubRepoId >", a Bamboo cicd_scope's id is 'bamboo:BambooPlan:< BambooConnectionId >:< BambooPlanKey >' | PK |
| `name` | varchar | 255 | The name of cicd_scope. | |
| `description` | longtext | | The description of cicd_scope. | |
| `url` | varchar | 255 | The url of cicd_scope. E.g. https://github.com/apache/incubator-devlake or https://jenkins.xxx.cn/view/PROD/job/OPS_releasev2/ | |
-| `created_date` | datetime | 3 | cicd_scope creation date | |
-| `updated_date` | datetime | 3 | Date of the last data collection for this cicd_scope | |
+| `created_date` | datetime | 3 | Creation date of the cicd_scope, nullable | |
+| `updated_date` | datetime | 3 | Updation date of the cicd_scope, nullable | |
#### cicd_pipelines
-A cicd_pipeline is a series of cicd_tasks, e.g. a GitHub workflow run, a GitLab pipeline, a BitBucket pipeline, a Jenkins build, etc.
+A cicd_pipeline is the abstraction of a top-level CI/CD execution, e.g. a GitHub workflow run, a GitLab pipeline, a BitBucket pipeline, a Jenkins build, a Bamboo plan build, etc. A cicd_pipeline contains one or more of cicd_tasks.
| **field** | **type** | **length** | **description** | **key** |
| :-------------- | :-------------- | :--------- | :-------------------------------------------------------------------------------------------- | :---------------- |
| `id` | varchar | 255 | This key is generated based on details from the original plugin | PK |
| `name` | varchar | 255 | For gitlab, as there is no name for pipeline, so we use projectId, others have their own name | |
-| `result` | varchar | 100 | The result of this task, e.g. SUCCESS, FAILURE | |
-| `status` | varchar | 100 | The status of this task, e.g. IN_PROGRESS, DONE | |
-| `type` | varchar | 100 | To indicate if this is a DEPLOYMENT | |
-| `duration_sec` | bigint unsigned | | how long does this task take | |
-| `created_date` | datetime | 3 | when did this task start | |
-| `finished_date` | datetime | 3 | when did this task finish | |
-| `environment` | varchar | 255 | To indicate the environment in which the task is running | |
+| `result` | varchar | 100 | The result of the pipeline. It will be standardized to 'SUCCESS', 'FAILURE' in DevLake based on each plugin's possible results. | |
+| `status` | varchar | 100 | The status of the pipeline. It will be standardized to 'DONE', 'IN_PROGRESS' in DevLake based on each plugin's possible statues. |
+| `type` | varchar | 100 | The value will be set to 'DEPLOYMENT' if it matched the ReGex configured in the Scope Config, otherwise it is an empty string. | |
+| `environment` | varchar | 255 | The value will be set to 'PRODUCTION' if it matched the ReGex configured in the Scope Config, otherwise it is an empty string. | |
+| `duration_sec` | bigint unsigned | | how long does this pipeline take | |
+| `created_date` | datetime | 3 | When this pipeline started | |
Review Comment:
`When this pipeline started` or `When this pipeline created`?
--
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] d4x1 merged pull request #640: docs: update CICD models' description
Posted by "d4x1 (via GitHub)" <gi...@apache.org>.
d4x1 merged PR #640:
URL: https://github.com/apache/incubator-devlake-website/pull/640
--
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 #640: docs: update CICD models' description
Posted by "Startrekzky (via GitHub)" <gi...@apache.org>.
Startrekzky commented on code in PR #640:
URL: https://github.com/apache/incubator-devlake-website/pull/640#discussion_r1330026701
##########
docs/DataModels/DevLakeDomainLayerSchema.md:
##########
@@ -441,36 +441,37 @@ Normal comments, review bodies, reviews' inline comments of GitHub's pull reques
#### cicd_scopes
-The entity to filter or group 'cicd_pipelines' or 'cicd_tasks'.
+The entity to filter or group 'cicd_pipelines'.
- For GitHub: a GitHub repo is converted to a cicd_scope
- For GitLab: a GitLab project is converted to a cicd_scope
- For Jenkins: a Jenkins job is converted to a cicd_scope
+- For Bamboo CI: a Bamboo plan is converted to a cicd_scope
| **field** | **type** | **length** | **description** | **key** |
| :------------- | :------- | :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ |
-| `id` | varchar | 255 | A cicd_scope's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..."<br/>For example, a Github cicd_scope's id is like "< github >:< GithubRepos >:< ConnectionId >:< GithubRepoId >". E.g. 'github:GithubRepos:1:384111310' | PK |
+| `id` | varchar | 255 | A cicd_scope's `id` is composed of "< plugin >:< Entity >:< PluginConnectionId >[:PK1]..."<br/>For example, a GitHub cicd_scope's id is "github:GithubRepos:< GithubConnectionId >:< GithubRepoId >", a Bamboo cicd_scope's id is 'bamboo:BambooPlan:< BambooConnectionId >:< BambooPlanKey >' | PK |
| `name` | varchar | 255 | The name of cicd_scope. | |
| `description` | longtext | | The description of cicd_scope. | |
| `url` | varchar | 255 | The url of cicd_scope. E.g. https://github.com/apache/incubator-devlake or https://jenkins.xxx.cn/view/PROD/job/OPS_releasev2/ | |
-| `created_date` | datetime | 3 | cicd_scope creation date | |
-| `updated_date` | datetime | 3 | Date of the last data collection for this cicd_scope | |
+| `created_date` | datetime | 3 | Creation date of the cicd_scope, nullable | |
+| `updated_date` | datetime | 3 | Updation date of the cicd_scope, nullable | |
#### cicd_pipelines
-A cicd_pipeline is a series of cicd_tasks, e.g. a GitHub workflow run, a GitLab pipeline, a BitBucket pipeline, a Jenkins build, etc.
+A cicd_pipeline is the abstraction of a top-level CI/CD execution, e.g. a GitHub workflow run, a GitLab pipeline, a BitBucket pipeline, a Jenkins build, a Bamboo plan build, etc. A cicd_pipeline contains one or more of cicd_tasks.
| **field** | **type** | **length** | **description** | **key** |
| :-------------- | :-------------- | :--------- | :-------------------------------------------------------------------------------------------- | :---------------- |
| `id` | varchar | 255 | This key is generated based on details from the original plugin | PK |
| `name` | varchar | 255 | For gitlab, as there is no name for pipeline, so we use projectId, others have their own name | |
-| `result` | varchar | 100 | The result of this task, e.g. SUCCESS, FAILURE | |
-| `status` | varchar | 100 | The status of this task, e.g. IN_PROGRESS, DONE | |
-| `type` | varchar | 100 | To indicate if this is a DEPLOYMENT | |
-| `duration_sec` | bigint unsigned | | how long does this task take | |
-| `created_date` | datetime | 3 | when did this task start | |
-| `finished_date` | datetime | 3 | when did this task finish | |
-| `environment` | varchar | 255 | To indicate the environment in which the task is running | |
+| `result` | varchar | 100 | The result of the pipeline. It will be standardized to 'SUCCESS', 'FAILURE' in DevLake based on each plugin's possible results. | |
+| `status` | varchar | 100 | The status of the pipeline. It will be standardized to 'DONE', 'IN_PROGRESS' in DevLake based on each plugin's possible statues. |
+| `type` | varchar | 100 | The value will be set to 'DEPLOYMENT' if it matched the ReGex configured in the Scope Config, otherwise it is an empty string. | |
+| `environment` | varchar | 255 | The value will be set to 'PRODUCTION' if it matched the ReGex configured in the Scope Config, otherwise it is an empty string. | |
Review Comment:
@d4x1 I was trying to use RegEx...
--
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 #640: docs: update CICD models' description
Posted by "Startrekzky (via GitHub)" <gi...@apache.org>.
Startrekzky commented on code in PR #640:
URL: https://github.com/apache/incubator-devlake-website/pull/640#discussion_r1330028362
##########
docs/DataModels/DevLakeDomainLayerSchema.md:
##########
@@ -441,36 +441,37 @@ Normal comments, review bodies, reviews' inline comments of GitHub's pull reques
#### cicd_scopes
-The entity to filter or group 'cicd_pipelines' or 'cicd_tasks'.
+The entity to filter or group 'cicd_pipelines'.
- For GitHub: a GitHub repo is converted to a cicd_scope
- For GitLab: a GitLab project is converted to a cicd_scope
- For Jenkins: a Jenkins job is converted to a cicd_scope
+- For Bamboo CI: a Bamboo plan is converted to a cicd_scope
| **field** | **type** | **length** | **description** | **key** |
| :------------- | :------- | :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ |
-| `id` | varchar | 255 | A cicd_scope's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..."<br/>For example, a Github cicd_scope's id is like "< github >:< GithubRepos >:< ConnectionId >:< GithubRepoId >". E.g. 'github:GithubRepos:1:384111310' | PK |
+| `id` | varchar | 255 | A cicd_scope's `id` is composed of "< plugin >:< Entity >:< PluginConnectionId >[:PK1]..."<br/>For example, a GitHub cicd_scope's id is "github:GithubRepos:< GithubConnectionId >:< GithubRepoId >", a Bamboo cicd_scope's id is 'bamboo:BambooPlan:< BambooConnectionId >:< BambooPlanKey >' | PK |
| `name` | varchar | 255 | The name of cicd_scope. | |
| `description` | longtext | | The description of cicd_scope. | |
| `url` | varchar | 255 | The url of cicd_scope. E.g. https://github.com/apache/incubator-devlake or https://jenkins.xxx.cn/view/PROD/job/OPS_releasev2/ | |
-| `created_date` | datetime | 3 | cicd_scope creation date | |
-| `updated_date` | datetime | 3 | Date of the last data collection for this cicd_scope | |
+| `created_date` | datetime | 3 | Creation date of the cicd_scope, nullable | |
+| `updated_date` | datetime | 3 | Updation date of the cicd_scope, nullable | |
#### cicd_pipelines
-A cicd_pipeline is a series of cicd_tasks, e.g. a GitHub workflow run, a GitLab pipeline, a BitBucket pipeline, a Jenkins build, etc.
+A cicd_pipeline is the abstraction of a top-level CI/CD execution, e.g. a GitHub workflow run, a GitLab pipeline, a BitBucket pipeline, a Jenkins build, a Bamboo plan build, etc. A cicd_pipeline contains one or more of cicd_tasks.
| **field** | **type** | **length** | **description** | **key** |
| :-------------- | :-------------- | :--------- | :-------------------------------------------------------------------------------------------- | :---------------- |
| `id` | varchar | 255 | This key is generated based on details from the original plugin | PK |
| `name` | varchar | 255 | For gitlab, as there is no name for pipeline, so we use projectId, others have their own name | |
-| `result` | varchar | 100 | The result of this task, e.g. SUCCESS, FAILURE | |
-| `status` | varchar | 100 | The status of this task, e.g. IN_PROGRESS, DONE | |
-| `type` | varchar | 100 | To indicate if this is a DEPLOYMENT | |
-| `duration_sec` | bigint unsigned | | how long does this task take | |
-| `created_date` | datetime | 3 | when did this task start | |
-| `finished_date` | datetime | 3 | when did this task finish | |
-| `environment` | varchar | 255 | To indicate the environment in which the task is running | |
+| `result` | varchar | 100 | The result of the pipeline. It will be standardized to 'SUCCESS', 'FAILURE' in DevLake based on each plugin's possible results. | |
+| `status` | varchar | 100 | The status of the pipeline. It will be standardized to 'DONE', 'IN_PROGRESS' in DevLake based on each plugin's possible statues. |
+| `type` | varchar | 100 | The value will be set to 'DEPLOYMENT' if it matched the ReGex configured in the Scope Config, otherwise it is an empty string. | |
+| `environment` | varchar | 255 | The value will be set to 'PRODUCTION' if it matched the ReGex configured in the Scope Config, otherwise it is an empty string. | |
+| `duration_sec` | bigint unsigned | | how long does this pipeline take | |
+| `created_date` | datetime | 3 | When this pipeline started | |
Review Comment:
They are the same in this case, but I can get it updated.
--
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