There was an error generating sponsors. ❌ - Cannot read 'viewer' of undefined

[adi1090x]

Failed to generate sponsors

the previous version was working fine, now i get this error after new release : Error: There was an error generating the updated file: Cannot read property 'viewer' of undefined ❌

> Run JamesIves/github-sponsors-readme-action@v1

    GitHub Sponsors Readme Action 💖

    🚀 Getting Started Guide: https://github.com/JamesIves/github-sponsors-readme-action
    ❓ Discussions / Q&A: https://github.com/JamesIves/github-sponsors-readme-action/discussions
    🔧 Report a Bug: https://github.com/JamesIves/github-sponsors-readme-action/issues

    📣 Maintained by James Ives: https://jamesiv.es/
    💖 Support: https://github.com/sponsors/JamesIves
Checking configuration and initializing… 🚚
Fetching data from the GitHub API as User… ⚽
Generating updated README.md file… 📁
Generating template… ✨
Error: There was an error generating the updated file: Cannot read property 'viewer' of undefined ❌
There was an error generating sponsors. ❌

Here's my workflow yml

File : .github/workflows/sponsors.yml

name: Generate Sponsors README
on:
  push:
    branches:
      - master
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v2

      - name: Generate Sponsors 💖
        uses: JamesIves/github-sponsors-readme-action@v1
        with:
          token: ${{ secrets.PAT_GHS }}
          file: 'README.md'

      - name: Deploy to GitHub Pages 🚀
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          branch: master
          folder: '.'

PAT has a scope user:read as well.
Is this a bug in new release, or I'm doing something wrong here?

[JamesIves]

Are you fetching as a user or an organization? The two scopes I've provided my action are read:user and read:org which works. There was an issue in a previous version that made it so you couldn't fetch sponsors if they were part of an organization, so you may need to bump the permissions slightly as this has been addressed. I've updated the documentation to address this so it's clearer. Apologies if this has caused any problems, it probably should have been a major version change.

If you are fetching sponsors as an organization account, you must provide the action with organization: true as viewer is used for user level accounts.

[adi1090x]

Hello @JamesIves

I'm fetching as a user. Still not sure what's causing that. It only started happening after the new release. Before that (probably 5 days ago) it was working just fine (with same yml and PAT)

[JamesIves]

Can you share the permission levels of your PAT? Is it scoped as read:user and read:org? The new release requires additional scope.

[adi1090x]

Share the permission levels (how?)

That's the only selected scope for my PAT.

I do also have an organization (But why should it matter, The repository is in my user profile, Not in organization)

[adi1090x]

Also doesn't work on these scopes as well

.

[JamesIves]

By sharing I meant providing screenshots of the permission levels.

The read:org permission is required as the action requests Organization in the GraphQL query, this is done so if an organization user sponsors you it will show up in your list of sponsors, the bug this fixed was causing organization sponsors to a user account to not show up. If you're trying to populate a list of sponsors as an organization account you'd provide the same permission scope but you'd also set the organization parameter in the workflow to true.

The action requires read only permission to user and org even as a user account. Can you please try selecting read:user and read:org and try again?

[adi1090x]

Yes, That worked!

Apparently, the action now needs both scopes.

Thank you.

[JamesIves]

I'm glad that worked! Pinning for visibility.

[vitalets]

The action requires read only permission to user and org even as a user account.

This should definitely be highlighted in docs and in error message!
As now it looks like If you want sponsors for user account request only user:read permission.

[JamesIves]

It is mentioned several times 😅