Skip to content

Commit a6bf785

Browse files
authored
Feature: Exclude/Include users from report (#70)
* Feature: Exclude/Include users from report * Fix: Correct unreviewed and unapproved calculations
1 parent 41f0e91 commit a6bf785

18 files changed

Lines changed: 466 additions & 410 deletions

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Shows the total volume of code merged, reviews conducted, and comments in PRs. H
9797
| **dev3** | 17 | 17 | 0 | 1 | 1 | +1305/-310 | 14/1/1/0/1 |
9898
| **total** | 78 | 77 | 0 | 3 | 4 | +8395/-3479 | 51/15/5/3/4 |
9999

100-
### Discussion Intensity (Authors Perspective)
100+
### Discussion Intensity (Author's Perspective)
101101

102102
Measures how discussion-heavy PRs are from the author's perspective, based on open discussions, review statuses, and the number of comments. Additionally, you can track discussion topics and user agreement by adding discussion topics in `[[]]` and using thumbs up/down ( :+1: / :-1: ) reactions on the opening comment. Use the `pr-quality` value in the `SHOW_STATS_TYPES` parameter.
103103

@@ -118,7 +118,7 @@ title Discussions types total 12/2023
118118
"Formatting(9)":9
119119
```
120120

121-
### Discussion Intensity (Reviewers Perspective)
121+
### Discussion Intensity (Reviewer's Perspective)
122122

123123
Measures how discussion-heavy PRs are from the reviewer's perspective, based on discussions, comments, and PR statuses. Helps understand reviewer engagement and decision-making. Use the `code-review-engagement` value in the `SHOW_STATS_TYPES` parameter and add thumbs up/down ( :+1: / :-1: ) reactions on opening comments.
124124

@@ -333,6 +333,8 @@ Below is a table outlining the various configuration parameters available for **
333333
| `SHOW_USERS` | Displays only specified users in reports, but includes all users in the background analytics. Use `total` to show total stats. Users should be separated by commas. | - |
334334
| `EXCLUDE_LABELS` | PRs with mentioned labels will be excluded from the report . Values should be separated by commas. Example: `bugfix, enhancement` | - |
335335
| `INCLUDE_LABELS` | Only PRs with mentioned labels will be included in the report. Values should be separated by commas. Example: `bugfix, enhancement` | - |
336+
| `INCLUDE_USERS` | Only data for the specified users will be included in the report. Multiple values should be separated by commas. Example: `dev1, dev2` | - |
337+
| `EXCLUDE_USERS` | Data for the specified users will be excluded from the report. Multiple values should be separated by commas. Example: `dev1, dev2` | - |
336338
| `EXECUTION_OUTCOME` | This parameter allows you to specify the format in which you wish to receive the report. Options include creating a new issue, updating an existing one, obtaining markdown, or JSON. Markdown and JSON will be available in outputs. Can take mulitple values separated by commas: `new-issue`, `markdown`, `collection`, `existing-issue`. This parameter is **required** Example: `existing-issue` | `new-issue` |
337339
| `ISSUE_NUMBER` | Issue number to update. Add `existing-issue` to `EXECUTION_OUTCOME` for updating existing issue. The specified issue must already exist at the time the action is executed. This parameter is mandatory if the `EXECUTION_OUTCOME` input includes `existing-issue` value | - |
338340
| `ALLOW_ANALYTICS` | Allows sending non-sensitive inputs to mixpanel for better understanding user's needs. Set the value to `false` to disable sending action parameter data | `true` |

action.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ inputs:
9696
EXCLUDE_LABELS:
9797
description: "Excludes PRs with mentioned labels. Values should be separated by comma"
9898
required: false
99+
INCLUDE_USERS:
100+
description: "Only data for the specified users will be included in the report. Multiple values should be separated by commas"
101+
required: false
102+
EXCLUDE_USERS:
103+
description: "Data for the specified users will be excluded from the report. Multiple values should be separated by commas"
104+
required: false
99105
TIMEZONE:
100106
description: "Timezone to use in action"
101107
required: false

0 commit comments

Comments
 (0)