Does The Action Scrape custom tiers as well to collect sponsors with minimum and maximum logic

[tallguyjenks]

I implemented the Github action

name: Generate Sponsors README
on:
  workflow_dispatch:
  schedule:
    - cron: "* 3 * * *"

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v4

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

      - name: Deploy to GitHub Pages 🚀
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          token: ${{ secrets.PERSONAL_AUTH_TOKEN }}
          branch: main
          folder: "."

and it works perfectly.

However i used the minimum: 2900
value with the action per the documentation and my custom sponsor at $30 or 3000 was not picked up by the job.

Feature request is that the job also scrapes the custom tiers if not by default then at least when the minimum or maximum criteria are set

thanks for the great GitHub action!

[tallguyjenks]

Note: i just realized that, the custom sponsor not being picked up is in fact a private sponsor, so in that instance there is no error, however i would still link confirmation that custom tiers will get picked up if the minimum value is set to less than what a custom tier is sponsoring for

[JamesIves]

If you set a minimum value of 2900, anyone that falls below the 2900 will not picked up. You'd need to donate 2900+ for the job to display the sponsorship in the readme. You can additionally specify a range by defining both a maximum and a minimum value.

As far as the actions concerned, all it does is query the GitHub API to get the sponsorship amount, it does not check if your sponsorship tiers are custom or not. If a user doesn't choose a specific sponsorship tier and instead chooses to define their own sponsorship value via a custom amount, they'd still be eligible to be displayed in the readme. Even if it's a one time payment, it will be valid for a specific period until it no longer shows as a response in the api payload, I believe 30 days.

As you've already discovered if the users sponsorship is private, the action will respect the privacy of the user, even though the data is technically returned from the API as it's still visible to the user associated with the personal access token.

Hope that helps!

[tallguyjenks]

yes that answers my question perfectly, thank you!