Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs improvements in README.md #137

Merged
merged 7 commits into from
Oct 11, 2023
Merged

Docs improvements in README.md #137

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8fd240d
Use same order of 'searchable things' as in the 2nd sentence
spier Oct 10, 2023
be4ede6
Separate the measurement and report generation more clearly. Also men…
spier Oct 10, 2023
1fc8c17
Formatting of variable
spier Oct 10, 2023
2942b9d
Fix spacing
spier Oct 10, 2023
70b28a8
Add spacing after markdown headlines
spier Oct 10, 2023
fea4dd3
Add spacing ahead of codeblocks
spier Oct 10, 2023
7236dbf
Separate footnotes
zkoppert Oct 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@

[![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 pull requests/issues/discussions in a repository and measures and reports on
several metrics. The issues/pull requests/discussions to search for can be filtered by using a search query.
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.

The metrics that are measured are:
| Metric | Description |
|--------|-------------|
| Time to first response | The time between when an issue/pull request/discussion is created and when the first comment or review is made.* |
| Time to close | The time between when an issue/pull request/discussion is created and when it is closed.* |
| Time to answer | (Discussions only) The time between when a discussion is created and when it is answered. |
| 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 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.
zkoppert marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -80,6 +80,7 @@ Below are the allowed configuration options:
### Example workflows

#### Calculated Time Example

This workflow searches for the issues created last month, and generates an issue with metrics.

```yaml
Expand Down Expand Up @@ -130,6 +131,7 @@ jobs:
```

#### Fixed Time Example

This workflow searches for the issues created between 2023-05-01..2023-05-31, and generates an issue with metrics.

```yaml
Expand Down Expand Up @@ -212,6 +214,7 @@ jobs:
```

## SEARCH_QUERY

Issues or Pull Requests? Open or closed?
This action can be configured to run metrics on discussions, pull requests and/or issues. It is also configurable by whether they were open or closed in the specified time window. Further query options are listed in the [documentation on searching issues and pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests) or the [documentation on searching discussions](https://docs.github.com/en/search-github/searching-on-github/searching-discussions). Search results are limited to 1000 results by the GitHub API. Here are some search query examples:

Expand Down Expand Up @@ -268,7 +271,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: <YOUR_GITHUB_HANDLE_HERE>
Expand Down Expand Up @@ -354,6 +357,7 @@ then the report will look like this:
## Example issue_metrics.md output

Here is the output with no hidden columns:

```markdown
# Issue Metrics

Expand All @@ -375,6 +379,7 @@ Here is the output with no hidden columns:
```

Here is the output with all hidable columns hidden:

```markdown
# Issue Metrics

Expand Down