From 4447e12600dba2d397e4a9c682951c2278d6d95e Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Wed, 23 Oct 2024 13:49:21 -0700 Subject: [PATCH] docs: add draft pr tracking to readme Signed-off-by: Zack Koppert --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d429178..cc291aa 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Feel free to inquire about its usage by creating an issue in this repository. | Time to Close | The period from creation to closure.\* | | Time to Answer (Discussions Only) | The time from creation to an answer. | | Time in Label | The duration from label application to removal, requires `LABELS_TO_MEASURE` env variable. | +| Time in Draft (PRs Only) | The duration from creation to the PR being marked as ready for review. | \*For pull requests, these metrics exclude the time the PR was in draft mode. @@ -151,6 +152,7 @@ This action can be configured to authenticate with GitHub App Installation or Pe | `HIDE_TIME_TO_ANSWER` | False | False | If set to `true`, the time to answer a discussion will not be displayed in the generated Markdown file. | | `HIDE_TIME_TO_CLOSE` | False | False | If set to `true`, the time to close will not be displayed in the generated Markdown file. | | `HIDE_TIME_TO_FIRST_RESPONSE` | False | False | If set to `true`, the time to first response will not be displayed in the generated Markdown file. | +| `DRAFT_PR_TRACKING` | False | False | If set to `true`, draft PRs will be included in the metrics as a new column and in the summary stats. | | `IGNORE_USERS` | False | False | A comma separated list of users to ignore when calculating metrics. (ie. `IGNORE_USERS: 'user1,user2'`). To ignore bots, append `[bot]` to the user (ie. `IGNORE_USERS: 'github-actions[bot]'`) Users in this list will also have their authored issues and pull requests removed from the Markdown table. | | `ENABLE_MENTOR_COUNT` | False | False | If set to 'TRUE' count number of comments users left on discussions, issues and PRs and display number of active mentors | | `MIN_MENTOR_COMMENTS` | False | 10 | Minimum number of comments to count as a mentor |