github-sponsor-report

Make your GitHub Sponsors report page.

Screenshot

An example view of GitHub Sponsor Report.

Usage

1. Create a report repository using this Template
   • Recommend: create a repository as private
   • :warning: Some data includes private data
2. Set PERSONAL_GITHUB_TOKEN to your repo's secrets
   • New personal access token → select read:org and user permission
   • https://github.com/{yourname}/{repo}/settings/secrets/actions
3. Update data manually
   1. Go to https://github.com/{yourname}/{repo}/actions/workflows/update-data.yml
   2. Run workflow

After the setup, update data every hour by GitHub Actions.

Options

• GITHUB_TOKEN: GitHub Token which has user and read: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
• 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.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

• azu: GitHub, Twitter

License

MIT © azu