All notable changes to this project will be documented in this file.
- Adds new available stats:
reviewedAdditions
,reviewedDeletions
,reviewedLines
,totalObservations
,medianObservations
,revisionSuccessRate
,additions
,deletions
andlines
.
commentsPerReview
is calculated now as the median, not the average.
- New
stats
option to specify the stats to be calculated.
- Deprecated the kebab case options:
publish-as
,disable-links
,sort-by
,slack-webhook
,slack-channel
andteams-webhook
. Now you need to use the camel case format:publishAs
,disableLinks
,sortBy
,slackWebhook
,slackChannel
andteamsWebhook
.` - The values for
sortBy
have changed.REVIEWS
,TIME
,COMMENTS
are invalid. Now you need to use the full name of the stat that will be used for sorting, for example:totalComments
,timeToReview
... - The JSON output for the action and the JSON payload for the webhook have changed. Check the new format in the webhook documentation.
- Renamed branch
master
tomain
.
- Prevents
githubToken
andpersonalToken
from be included in the JSON output.
- Fix on "Build with" link.
- Adds web version announcement.
- Support for hosted GitHub variants with non-standard domains (e.g., GitHub Enterprise).
- Announcing the web version development.
- Improved telemetry, by adding a reviewers summary.
- "Build with" link in the footer.
exclude
option to exclude specific users from the stats.
- Reduces the block size in the Slack messages to prevent hitting the characters limit.
- #85 Use Node v20 (by antonindrawan)
- #76 Add stats as a github step output (by Danny McCormick)
- Changed input to camelCase format, keeping the old ones for backward compatibility. Eg:
publish-as
is nowpublishAs
.
- #75 Iterate pull request pages correctly when having null authors (by Glen Keane)
publish-as
config now supports theNONE
option to prevent publishing the stats in the pull request.
- #70 Removes
-review:none
filter. Let PRs with requested changes be included in the stats (By Danny McCormick).
- Reference to "Recap" action.
- Adding Recap and Link actions.
- Get private sponsors from a dynamic list.
- A new private sponsor 💙
- A new private sponsor 💙
- A new private sponsor 💙
- Updated sponsorship policy to make it more flexible.
- #61 Post results in the Action Summary (By Petar Alilovic).
- #60 Display last repository in slack and teams message body (By Daeeun Kim).
- A new private sponsor 💙
- Microsoft Teams integration.
- Running on NodeJS 16.
- Webhooks integration.
- #48 Prevent sponsorship query error on Github Enterprise environments.
- #38 Split Slack message to prevent hitting characters limit.
- #46 Filtering reviewers with
undefined
name.
- Support for external sponsors.
- Improved description links.
- #44 Fixed problem reading repo when triggered by
schedule
event.
- #37 Problem causing
token
parameter to be empty.
- Printing the name and link of the organization or repos that are included on stats calculation.
- #24 Adds option
publish-as
to publish the resulting stats in the Pull Request description or as a comment.
- Switching default publication strategy to
COMMENT
.
- #33 Limits links length to 1,024 characters to prevent
KeyTooLongError
error. - #34 Permits running the action with
schedule
trigger.
- Logs to debug Slack integration.
- Slack integration.
- Makes "telemetry" a premium feature for sponsors.
- Moved from AGPLv3 license to MIT ❤️
- Add disclaimer about privacy (#22 by marcocrasso).
- Add
telemetry
option to prevent monitoring data used to improve this action.
- #20 Add extra new line before stats table (#21 by dantehemerson).
- Support for
pull_request_target
event.
- Fixes a bug introduced with
limit
option (reviewers sort was broken).
- Option
limit
to indicate the maximum numbers of rows to display in the table (#13 by escudero89)
- #7 Do not duplicate results table when there's no other content
- Ignore pull requests of deleted users (by Derek Young)
- Fixes bug related with bots authoring or reviewing pull requests (#3)
- Fixed bug on
href
property in avatars (adds ").
- Adds the option
organization
to calculate the stats across all the repos in the organization.
- Switched to Github's GraphAPI to minimize the number of requests and calculate the stats faster.
- The stats are printed at the bottom of the description of the pull request, rather than as a commit comment.
- When the title
Pull reviewers stats
is already present in the pull request the action is skipped. Avg. time to first review
is renamed toMedian time to review
, and is no longer the average but the median.Total pull reviews
is renamed toTotal reviews
.- The default order is now by
Total reviews
. - The columns order depends on the
sort-by
option, to put the sorting column first.
- Adds links in the "Avg. time to first review" column to a chart with the historical data.
- Adds the option
disable-links
to remove the links to the charts.
- Adds support for the
pull_request
event.
- Adds Mixpanel to get some usage insights.
- Bug fixing.
- First launch, with ♥ from Guadalajara, Mexico.