abordage / wakatime-box

Show your WakaTime statistics in a pinned gist for your GitHub profile

WakaTime Statistics in your GitHub profile

Automatically update your pinned gist with weekly (monthly, yearly) WakaTime statistics.

▶ See example

How it works

1. Create WakaTime account (it's free)
2. Enable Display code time publicly and Display languages, editors... in WakaTime profile settings
3. Copy WakaTime API Key
4. Create a token in your GitHub account settings with the gist scope only and copy it
5. Create a new public Gist and copy ID from url (string after last slash)
6. Fork this repo
7. Go to Settings > Secrets > Actions secrets in your fork
8. Create new Environment secrets:
   • GH_TOKEN: GitHub token generated earlier
   • WAKA_API_KEY: API key for your WakaTime account
   • GIST_ID: your Gist ID
   • (Optional) WAKATIME_BASE_URL: If you are using a WakaTime-compatible backend (e.g. Wakapi), set this to the corresponding base URL.

It's all. Go to Actions > WakaTime Stats and Run workflow. Gist should update and show your WakaTime stats. Next, statistics will be updated automatically every day. Pin this gist on your profile!

Inspired from matchai/waka-box and other awesome pinned-gist project

Compared to package matchai/waka-box:

1. customizable time range
2. customizable number of languages
3. correct time counting of other languages
4. summary report on action

Optional settings

You can specify optional settings in your file .github/workflows/schedule.yml.

Feedback

If you have any feedback, comments or suggestions, please feel free to open an issue within this repository.

Contributing

Please see CONTRIBUTING for details.

Credits

• Pavel Bychko (abordage)
• All Contributors

License

The MIT License (MIT). Please see License File for more information.