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/03 07:32:39 UTC
[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #312: docs: add workflow filter for github ci/cd
Startrekzky commented on code in PR #312:
URL: https://github.com/apache/incubator-devlake-website/pull/312#discussion_r1012560134
##########
docs/UserManuals/ConfigUI/GitHub.md:
##########
@@ -45,30 +45,37 @@ Usually, you don't have to modify this part. However, if you don't want to colle
### Step 3 - Adding Transformation Rules (Optional)
Review Comment:
Just use 'Add Transformation (Optional)'?
##########
docs/UserManuals/ConfigUI/GitHub.md:
##########
@@ -77,12 +84,17 @@ Each GitHub repo has at most ONE set of transformation rules.
#### Additional Settings (Optional)
+
+
+- PR Body Pattern: Extract the issue numbers closed by pull requests. The issue numbers are parsed from PR bodies that meet the following RegEx. For Example:
+ - ✅ Example 1: PR #321 body contains "**Closes #1234**" (PR #321 and issue #1234 will be mapped by the default RegEx)
+ - ❎ Example 2: PR #321 body contains "**Related to #1234**" (PR #321 and issue #1234 will NOT be mapped by the default RegEx)
+ - Default RegEx: `(?mi)(fix|close|resolve|fixes|closes|resolves|fixed|closed|resolved)[\s]*.*(((and )?(#|https:\/\/github.com\/%s\/%s\/issues\/)\d+[ ]*)+)`
+
- Tags Limit: It'll compare the last N pairs of tags to get the "commit diff', "issue diff" between tags. N defaults to 10.
Review Comment:
The new version of this configuration will be like: 
New Wording:
Enable commits diff to calculate version-based metrics:
Calculate the commits diff between two consecutive tags that match the following RegEx. Issues closed by PRs which contain these commits will also be calculated. The result will be shown in table.refs_commits_diffs and table.refs_issues_diffs
##########
docs/UserManuals/ConfigUI/GitHub.md:
##########
@@ -77,12 +84,17 @@ Each GitHub repo has at most ONE set of transformation rules.
#### Additional Settings (Optional)
+
+
+- PR Body Pattern: Extract the issue numbers closed by pull requests. The issue numbers are parsed from PR bodies that meet the following RegEx. For Example:
Review Comment:
This configuration is not additional setting any more. It's now called 'PR-Issue Mapping'. See pic
##########
docs/UserManuals/DORA.md:
##########
@@ -76,13 +77,14 @@ In the next section, we'll demonstrate how to configure DevLake to implement DOR
5. To make it simple, fields with a  label are DORA-related configurations for every data source. Via these fields, you can define what are "incidents" and "deployments" for each data source. After all data connections have been configured, click `Next Step`
- This team uses Jira issue types `Crash` and `Incident` as "incident", so choose the two types in field "incident". Jira issues in these two types will be transformed to "incidents" in DevLake.
- - This team uses the GitHub action jobs named `deploy` and `build-and-deploy` to deploy, so type in `(?i)deploy` to match these jobs. These jobs will be transformed to "deployments" in DevLake.
- 
+ - This team uses the GitHub action workflow named `Build workflow` deploy, so type in `(?i)Build` to match these workflows. Jobs in these workflow will be transformed to "deployments" in DevLake.
Review Comment:
I don't think this will solve the problem, as it can only tell DevLake jobs in which workflow runs can be collected, but it can't tell which jobs are `deployments`. Is it correct?
##########
docs/UserManuals/DORA.md:
##########
@@ -76,13 +77,14 @@ In the next section, we'll demonstrate how to configure DevLake to implement DOR
5. To make it simple, fields with a  label are DORA-related configurations for every data source. Via these fields, you can define what are "incidents" and "deployments" for each data source. After all data connections have been configured, click `Next Step`
- This team uses Jira issue types `Crash` and `Incident` as "incident", so choose the two types in field "incident". Jira issues in these two types will be transformed to "incidents" in DevLake.
- - This team uses the GitHub action jobs named `deploy` and `build-and-deploy` to deploy, so type in `(?i)deploy` to match these jobs. These jobs will be transformed to "deployments" in DevLake.
- 
+ - This team uses the GitHub action workflow named `Build workflow` deploy, so type in `(?i)Build` to match these workflows. Jobs in these workflow will be transformed to "deployments" in DevLake.
Review Comment:
I don't think this will solve the problem, as it can only tell DevLake jobs in which workflow runs can be collected, but it can't tell which jobs are `deployments`. Is it correct?
--
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