From f785a2e0938ae5080f59cd3a0284cf8136bcc4f7 Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Thu, 12 Oct 2023 16:15:57 -0700 Subject: [PATCH 1/3] Fix README collisions --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8bc26cf..88a963b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![CodeQL](https://github.com/github/issue-metrics/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/github/issue-metrics/actions/workflows/codeql-analysis.yml) [![Docker Image CI](https://github.com/github/issue-metrics/actions/workflows/docker-image.yml/badge.svg)](https://github.com/github/issue-metrics/actions/workflows/docker-image.yml) [![Python package](https://github.com/github/issue-metrics/actions/workflows/python-package.yml/badge.svg)](https://github.com/github/issue-metrics/actions/workflows/python-package.yml) -This is a GitHub Action that searches for issues/pull requests/discussions in a repository and measures and reports on several metrics. +This is a GitHub Action that searches for issues/pull requests/discussions in a repository, measures several metrics, and generates a report in form of a GitHub issue. The issues/pull requests/discussions to search for can be filtered by using a search query. | Metric | Description | @@ -10,9 +10,10 @@ The issues/pull requests/discussions to search for can be filtered by using a se |Time to First Response | The duration from creation to the initial comment or review.| |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 Label | The time between when a label has a specific label applied to an issue/pull request/discussion and when it is removed. This requires the `LABELS_TO_MEASURE` env variable to be set.| *For pull requests, these metrics exclude the time the PR was in draft mode. + *For Issue and pull requests, issue/pull request author's own comments and comments by bots are excluded. This action, developed by GitHub OSPO for our internal use, is open-sourced for your potential benefit. From 1a8ce1ed7122320961f90094018bfe94dee6963c Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Thu, 12 Oct 2023 16:20:36 -0700 Subject: [PATCH 2/3] fix collision --- docs/search-query.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/search-query.md b/docs/search-query.md index 9996483..5defd43 100644 --- a/docs/search-query.md +++ b/docs/search-query.md @@ -64,7 +64,7 @@ jobs: - name: Create issue for opened issues and prs uses: peter-evans/create-issue-from-file@v4 with: - title: Monthly issue metrics report for opened issues and prs + title: Monthly issue metrics report for opened issues and prs token: ${{ secrets.GITHUB_TOKEN }} content-filepath: ./issue_metrics.md assignees: From e8b46d3ccea6cd8a8fa9e8a6f6fcf12edd40cf6d Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Fri, 13 Oct 2023 14:33:34 -0700 Subject: [PATCH 3/3] Make config description concise Co-authored-by: Sebastian Spier --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 88a963b..093adc3 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The issues/pull requests/discussions to search for can be filtered by using a se |Time to First Response | The duration from creation to the initial comment or review.| |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 time between when a label has a specific label applied to an issue/pull request/discussion and when it is removed. This requires the `LABELS_TO_MEASURE` env variable to be set.| +|Time in Label | The duration from label application to removal, requires `LABELS_TO_MEASURE` env variable.| *For pull requests, these metrics exclude the time the PR was in draft mode.