Repository files navigation

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.

This action, developed by GitHub OSPO for our internal use, is open-sourced for your potential benefit.Feel free to inquire about its usage by creating an issue in this repository.

*For pull requests, these metrics exclude the time the PR was in draft mode.

*For issues and pull requests, comments by issue/pull request author's and comments by bots are excluded.

To find syntax for search queries, check out the documentation onsearching issues and pull requestsorsearching discussions.

The output of this action is a report in form of a GitHub issue.Below you see a sample of such a GitHub issue.

Create a workflow file (ie..github/workflows/issue-metrics.yml) in your repository with the following contents:

Note:repo:owner/repo is the repository you want to measure metrics on

name:Monthly issue metricson:workflow_dispatch:schedule:    -cron:"3 2 1 * *"permissions:contents:readjobs:build:name:issue metricsruns-on:ubuntu-latestpermissions:issues:writepull-requests:readsteps:      -name:Get dates for last monthshell:bashrun:|          # Calculate the first day of the previous month          first_day=$(date -d "last month" +%Y-%m-01)          # Calculate the last day of the previous month          last_day=$(date -d "$first_day +1 month -1 day" +%Y-%m-%d)          #Set an environment variable with the date range          echo "$first_day..$last_day"          echo "last_month=$first_day..$last_day" >> "$GITHUB_ENV"      -name:Run issue-metrics tooluses:github/issue-metrics@v3env:GH_TOKEN:${{ secrets.GITHUB_TOKEN }}SEARCH_QUERY:'repo:owner/repo is:issue created:${{ env.last_month }} -reason:"not planned"'      -name:Create issueuses:peter-evans/create-issue-from-file@v5with:title:Monthly issue metrics reporttoken:${{ secrets.GITHUB_TOKEN }}content-filepath:./issue_metrics.md

• As a maintainer, I want to see metrics for issues and pull requests on the repository I maintain in order to ensure I am giving them the proper amount of attention.
• As a first responder on a repository, I want to ensure that users are getting contact from me in a reasonable amount of time.
• As an OSPO, I want to see how many open source repository requests are open/closed, and metrics for how long it takes to get through the open source process.
• As a product development team, I want to see metrics around how long pull request reviews are taking, so that we can reflect on that data during retrospectives.

If you need support using this project or have questions about it, pleaseopen up an issue in this repository. Requests made directly to GitHub staff or support team will be redirected here to open an issue. GitHub SLA's and support/services contracts do not apply to this repository.

All feedback regarding our GitHub Actions, as a whole, should be communicated throughissues on our github-ospo repository.

1. Create a repository to host this GitHub Action or select an existing repository. This is easiest if it is the same repository as the one you want to measure metrics on.
2. Select a best fit workflow file from theexamples directory for your use case.
3. Copy that example into your repository (from step 1) and into the proper directory for GitHub Actions:.github/workflows/ directory with the file extension.yml (ie..github/workflows/issue-metrics.yml)
4. Edit the values (SEARCH_QUERY,assignees) from the sample workflow with your information. See theSEARCH_QUERY section for more information on how to configure the search query.
5. If you are running metrics on a repository other than the one where the workflow file is going to be, then update the value ofGH_TOKEN.
   • Do this by creating aGitHub API token with permissions to read the repository and write issues.
   • Then take the value of the API token you just created, andcreate a repository secret where the name of the secret isGH_TOKEN and the value of the secret the API token.
   • Then finally update the workflow file to use that repository secret by changingGH_TOKEN: ${{ secrets.GITHUB_TOKEN }} toGH_TOKEN: ${{ secrets.GH_TOKEN }}. The name of the secret can really be anything. It just needs to match between when you create the secret name and when you refer to it in the workflow file.
   • Help on verifying your token's access to your repositoryhere
6. If you want the resulting issue with the metrics in it to appear in a different repository other than the one the workflow file runs in, update the linetoken: ${{ secrets.GITHUB_TOKEN }} with your own GitHub API token stored as a repository secret.
   • This process is the same as described in the step above. More info on creating secrets can be foundhere.
7. Commit the workflow file to the default branch (oftenmaster ormain)
8. Wait for the action to trigger based on theschedule entry or manually trigger the workflow as shown in thedocumentation.

Below are the allowed configuration options:

This action can be configured to authenticate with GitHub App Installation or Personal Access Token (PAT). If all configuration options are provided, the GitHub App Installation configuration has precedence. You can choose one of the following methods to authenticate:

• Example workflows
• Measuring time spent in labels
• Assigning teams instead of individuals
• Example using the JSON output instead of the Markdown output
• Configuring theSEARCH_QUERY
• Local usage without Docker
• Authenticating with GitHub App Installation
• Dealing with large issue_metrics.md files

We would ❤️ contributions to improve this action. Please seeCONTRIBUTING.md for how to get involved.

• Ensure you have python3.10+ installed
• Clone this repository and cd intoissue-metrics
• Create python virtual envpython3 -m venv .venv
• Activate virtual envsource .venv/bin/activate
• Install dependenciespip install -r requirements.txt -r requirements-test.txt
• Run testsmake test
• Run lintermake lint

MIT

Looking for more resources for your open source program office (OSPO)? Check out thegithub-ospo repository for a variety of tools designed to support your needs.