github-sponsor-report
Make your GitHub Sponsors report page.
Screenshot
An example view of GitHub Sponsor Report.
Usage
-
Create a report repository using this Template
- Recommend: create a repository as
private
⚠️ Some data includes private data
- Recommend: create a repository as
- Set
PERSONAL_GITHUB_TOKEN
to your repo's secrets-
New personal access token → select
read:org
anduser
permission - https://github.com/{yourname}/{repo}/settings/secrets/actions
-
New personal access token → select
- Update data manually
- Go to https://github.com/{yourname}/{repo}/actions/workflows/update-data.yml
- Run workflow
After the setup, update data every hour by GitHub Actions.
Options
-
GITHUB_TOKEN
: GitHub Token which hasuser
andread:org
permission -
GENERATE_ONLY_IMAGE
: only generate image without snapshots data- If you want to make your report repository public, recommend to
GENERATE_ONLY_IMAGE=true
- If you want to make your report repository public, recommend to
-
PROJECT_ROOT_DIR
: project root directory -
OWNER_NAME
: You GitHub account id.
Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Author
License
MIT © azu