Contributors

• Date range for contributor list: 2024-03-01 to 2024-03-31
• Repository: ['github/contributors']

this file was generated by the Contributors GitHub Action

If folks have filled it out there is a company field in the user data that could be shown in the contributor report. See endpoint: https://docs.github.com/en/free-pro-team@latest/rest/users/users?apiVersion=2022-11-28#get-a-user

Lets make them into markdown links instead:

Before:

https://github.com/probot/probot/commits?author=zkoppert&since=2021-09-01&until=2023-09-30, https://github.com/probot/autoresponder/commits?author=zkoppert&since=2021-09-01&until=2023-09-30

After:
probot/probot, probot/autoresponder

Contributors

• Date range for contributor list: 2024-05-01 to 2024-05-31
• Repository: ['github/contributors']

this file was generated by the Contributors GitHub Action

Why are you seeing this issue?

This is a support escalation! You can find out more about expectations on communications and response times in the on-call docs. Thank you for doing your part to keep GitHub customers happy!

Severity

Note, for Sev1 issues always page the team first, using the PagerDuty information in the service catalog and the command .pager trigger <rotation> <reason>. Opening an issue for a Sev2 incident can come later (and can be done by the available Escalation Engineer).

• sev1 - Engineering must respond, when paged, within their on-call SLO
• sev2 - Engineering must respond to this issue within one business day
• sev3 - EPD squad for the team must respond to this issue within one week

Service

contributors

Issue

A clear and concise description of what the issue is.

A customer is not sure why they are not showing up in the contributors.

I had them check the following but I'm not sure what steps to have them try next or what the issue might be.

Top 100 Contributors: The contributors graph only shows the top 100 contributors. If you're not one of the top 100 contributors, you won't appear in the graph.

Commit Branch: Your commits need to be merged into the default branch or the gh-pages branch (if the repository has project sites) to appear in the contributors graph. If all your commits are on non-default branches, they won't be included in the graph.

Email Address: The email address used to author the commits must be connected to your GitHub account. If it's not, your commits won't be linked to your account, and you won't appear in the contributors graph. You can check the email address used for a commit by adding .patch to the end of a commit URL.

Their response to the questions.

Hi Alex,

1. I have selected the past month in the timeline graph but I still don't show up.

https://github.zendesk.com/attachments/token/BmlUNaBUzbGekV79wOPVtE3xT/?>name=Screen+Recording+2023-11-21+at+13.09.16.mov

2. My commits are being merged into the master branch

3. Email address

Customer Impact

• Zendesk Ticket(s) - 2444619

Customer is not seeing himself show up on the one below. The other 2 he does.

GitHub Product(s) Impacted (check appropriate boxes and provide GHES version if applicable)

• GitHub.com (including GHEC)
• GitHub Enterprise Server.
  If GHES, please list the version of GHES the customer is on here:
• GHAE

To Reproduce

Steps to reproduce the behavior:
N/A

Expected behavior

He wants to see himself as a contributor. In 2 repos he does but 1 he doesn't (see screenshots above).

Screenshots

See above.

Additional context

The customer is unity3d.

cc:
@github/ospo
@product_manager

Support Squad(s): @github/support-squad-

When checking an organization, any empty repo will cause the action to fail. Simply bad timing could mean a user creates a repo as the action is running.

Actual:
Exits with

Expected status_code 200 but got 204
Error getting contributors for repository: foo/bar
No more repositories will be processed. Please delete the (empty?) repository and try again.
204 [No message]

Expected;
Continues, perhaps logging

Error getting contributors for repository: foo/bar. It may be empty.

We got this error in the super-linter repo (https://github.com/super-linter/super-linter/actions/runs/6714831338/job/18248627198)

Traceback (most recent call last):
  File "/action/workspace/contributors.py", line 174, in <module>
    main()
  File "/action/workspace/contributors.py", line 23, in main
    ) = env.get_env_vars()
        ^^^^^^^^^^^^^^^^^^
  File "/action/workspace/env.py", line 56, in get_env_vars
    sponsor_info = sponsor_info.lower().strip()
                   ^^^^^^^^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'lower'

@zkoppert can you kindly have a look? Thanks!

Is your feature request related to a problem?

No

Describe the solution you'd like

Utilize the GitHub Actions Job Summary feature we could output the markdown as GitHub friendly markdown in the GitHub Action output.

Describe alternatives you've considered

We currently allow pushing the result to a Discussion or Issue. We definitely need to keep this but we can also output to the GitHub Actions screen

Additional context

No response

This would be useful for GItHub and potentially for other companies too.

Contributors

• Date range for contributor list: 2023-11-01 to 2023-11-30
• Repository: ['github/contributors']

this file was generated by the Contributors GitHub Action

Contributors

• Date range for contributor list: 2024-01-01 to 2024-01-31
• Repository: ['github/contributors']

this file was generated by the Contributors GitHub Action

Contributors

• Date range for contributor list: 2023-10-01 to 2023-10-31
• Repository: ['github/contributors']

this file was generated by the Contributors GitHub Action

This could go in a separate column or next to the users username.

this would actually utilize the avatar_urlwe are storing. Again, would need to make this optional so it doesn't clutter up the results for folks that don't want it. Maybe don't even turn on by default.

Contributors

• Date range for contributor list: 2024-02-01 to 2024-02-29
• Repository: ['github/contributors']

this file was generated by the Contributors GitHub Action

Contributors

• Date range for contributor list: 2024-04-01 to 2024-04-30
• Repository: ['github/contributors']

this file was generated by the Contributors GitHub Action

When run as an action, what is the full(er) path to the contributors.md file that needs to get read and added to an Issue?

In the markdown output, make the username a link to the github users profile

Add the OSSF Scorecard GitHub Action to this repo.

Why?

Allows us to detect supply chain security for this GitHub Action.

Actions

• setup GitHub Action
• add badge to README once wired-up

Contributors

• Date range for contributor list: 2023-12-01 to 2023-12-31
• Repository: ['github/contributors']

this file was generated by the Contributors GitHub Action

Contributors

• Date range for contributor list: 2024-06-01 to 2024-06-30
• Repository: ['github/contributors']

this file was generated by the Contributors GitHub Action

It seems that there is no check on the sponsor info variable

$ ORGANIZATION=scaleway REPOSITORY=scaleway-cli GH_TOKEN=$GITHUB_COM_TOKEN python3 ./contributors.py
Traceback (most recent call last):
  File "/Users/rleone/workspace/contributors/./contributors.py", line 176, in <module>
    main()
  File "/Users/rleone/workspace/contributors/./contributors.py", line 24, in main
    ) = env.get_env_vars()
        ^^^^^^^^^^^^^^^^^^
  File "/Users/rleone/workspace/contributors/env.py", line 56, in get_env_vars
    sponsor_info = sponsor_info.lower().strip()
                   ^^^^^^^^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'lower'

Describe the bug

When generating the report against an Organization using start_date and end_date, the Contributions Count is equal to the all time contributions for any repos in the report

In a report created, Top contributor has contributed to one repo in the time span. See screenshots for
I would expect their Contribution Count to be ~8 in the report; not 476

To Reproduce

• Create new repo with only this action with below code to get a short weeks period
• Trigger report generation via workflow_dispatch

name: Weekly contributor report
on:
  workflow_dispatch:
  # schedule:
  #   - cron: '0 4 * * 1'

permissions:
  contents: read

jobs:
  contributor_report:
    name: contributor report
    runs-on: ubuntu-latest
    permissions:
      issues: write

    steps:
      - name: Get dates for last week
        shell: bash
        run: |
          # Calculate the first day of the previous week
          start_date=$(date -d "last-sunday" +%Y-%m-%d)
  
          # Calculate the last day of the previous week
          end_date=$(date -d "$start_date +1 week -1 day" +%Y-%m-%d)
  
          #Set an environment variable with the date range
          echo "START_DATE=$start_date" >> "$GITHUB_ENV"
          echo "START_DATE=$start_date"
          echo "END_DATE=$end_date" >> "$GITHUB_ENV"
          echo "END_DATE=$end_date"

  
      - name: Run contributor action
        uses: github/[email protected]
        env:
          GH_APP_ID: ${{ secrets.GH_APP_ID }}
          GH_APP_INSTALLATION_ID: ${{ secrets.GH_APP_INSTALLATION_ID }}
          GH_APP_PRIVATE_KEY: ${{ secrets.GH_APP_PRIVATE_KEY }}
          START_DATE: ${{ env.START_DATE }}
          END_DATE: ${{ env.END_DATE }}
          ORGANIZATION: "XXXX"
          SPONSOR_INFO: "false"
      - name: Create issue
        uses: peter-evans/create-issue-from-file@v5
        with:
          title: Contributor report for ${{ env.START_DATE }} - ${{ env.END_DATE }}
          content-filepath: ./contributors.md
          assignees: xxxxxxxxx

Expected behavior

• User has contributed in the date range
• Contribution Count reflects contributions performed only during the date range

Screenshots

Generated report for 1 week:

Additional context

Referencing reports in this repo to narrow down when this changed

• #56 seems to correctly only count contributions from the time period
• #61 is the first report I find in this repo that shows total contribution count instead of time period
• This makes me suspect it may have been introduced around release v1.1.2 ; however as i have installed as github app I can not downgrade to test at this time

Contributors

• Date range for contributor list: 2023-09-01 to 2023-09-30
• Repository: github/contributors

this file was generated by the Contributors GitHub Action

contributors.md may overwrite an existing file so having an option would be a good idea.

Might look into opening a PR but it currently will fail and stop running on hitting a rate limit failure and does not create even a partial report.

To simplify user interaction with this repository we want to add GitHub Issue Templates.

• bug report
• feature request
• config
  • link to discussions
  • link to github-ospo repo for overall OSPO GitHub Action issues

This should probably be a configuration option given peoples opinions about loving or hating it notifying people.

If a user wants a contributor report on 3 repositories and they aren't the only 3 in the organization, They currently need to run the action 3 separate times. This could be fixed by allowing for a comma separated list of repositories to input instead of only taking one.

Contributors

• Date range for contributor list: 2024-07-01 to 2024-07-31
• Repository: ['github/contributors']

this file was generated by the Contributors GitHub Action