| name | OSPO Contributors Report | |||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| description | Monthly contributor activity metrics across an organization's repositories. | |||||||||||||||||||||||||||||||||||||||||||||||||||
| labels |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
| true |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
| permissions |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
| engine | copilot | |||||||||||||||||||||||||||||||||||||||||||||||||||
| tools |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
| safe-outputs |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
| timeout-minutes | 60 |
Generate a contributors report for the specified organization or repositories.
Check the workflow inputs. Either organization or repositories must be provided.
- If both are empty and this is a scheduled run, default to analyzing all public repositories in the organization that owns the current repository. Determine the org from the
GITHUB_REPOSITORYenvironment variable (the part before the/). - If both are empty and this is a manual dispatch, fail with a clear error message: "You must provide either an organization or a comma-separated list of repositories."
- If both are provided, prefer
repositoriesand ignoreorganization.
- If
start_dateandend_dateare provided, use them. - Otherwise, default to the previous calendar month. For example, if today is 2025-03-15, the range is 2025-02-01 to 2025-02-28.
- Use bash to compute the dates if needed. Store them as
START_DATEandEND_DATE.
- If
repositoriesinput was provided, split the comma-separated string into a list. Each entry should be inowner/repoformat. - If
organizationinput was provided (or defaulted from Step 1), list all public, non-archived, non-fork repositories in the organization using the GitHub API. Collect theirowner/repoidentifiers.
For each repository in scope:
- Use the GitHub API to list commits between
START_DATEandEND_DATE(use thesinceanduntilparameters on the commits endpoint). - For each commit, extract the author login (from
author.loginon the commit object). - Exclude bot accounts: skip any contributor whose username contains
[bot]or whosetypefield is"Bot". - Track per-contributor:
- Total number of commits across all repos.
- The set of repos they contributed to.
Use bash to aggregate and deduplicate the contributor data across all repositories.
For each contributor found in Step 4, check whether they have any commits before START_DATE in any of the in-scope repositories.
- If a contributor has no commits before
START_DATE, mark them as a New Contributor. - Otherwise, mark them as a Returning Contributor.
If the sponsor_info input is true:
- For each contributor, check whether they have a GitHub Sponsors profile by querying the user's profile via the GitHub API.
- If the user has sponsorship enabled, record their sponsor URL as
https://github.com/sponsors/<username>. - If not, leave the sponsor field empty.
Build a markdown report with the following structure:
| Metric | Value |
|---|---|
| Total Contributors | count |
| Total Contributions (Commits) | count |
| New Contributors | count |
| Returning Contributors | count |
| % New Contributors | percentage |
Sort contributors by commit count descending.
| # | Username | Contribution Count | New Contributor | Sponsor URL | Commits |
|---|---|---|---|---|---|
| 1 | @username | 42 | Yes | Sponsor | View |
- The Username column should link to the contributor's GitHub profile.
- The Sponsor URL column should show "N/A" if
sponsor_infois false or the user has no Sponsors page. - The Commits column should link to a filtered commits view.
Create an issue in the current repository with:
- Title:
[Contributors Report] <ORG_OR_REPO_SCOPE> — START_DATE to END_DATE - Body: The full markdown report from Step 7.
- Labels: Add the label
contributors-reportif it exists; do not fail if it does not.