bc-li / waka-box

📊 Update a pinned gist to contain your weekly WakaTime stats

waka-box

Update a pinned gist to contain your weekly WakaTime stats

---

📌✨ For more pinned-gist projects like this one, check out: https://github.com/matchai/awesome-pinned-gists

Setup

Prep work

1. Create a new public GitHub Gist (https://gist.github.com/)
2. Create a token with the gist scope and copy it. (https://github.com/settings/tokens/new)
3. Create a WakaTime account (https://wakatime.com/signup)
4. In your WakaTime profile settings (https://wakatime.com/settings/profile) ensure Display coding activity publicly and Display languages, editors, operating systems publicly are checked.
5. In your account settings, copy the existing WakaTime API Key (https://wakatime.com/settings/api-key)

Project setup

1. Fork this repo

2. Edit the environment variable in .github/workflows/schedule.yml:

   • GIST_ID: The ID portion from your gist url: https://gist.github.com/matchai/6d5f84419863089a167387da62dd7081.

3. Go to the repo Settings > Secrets

4. Add the following environment variables:

   • GH_TOKEN: The GitHub token generated above.
   • WAKATIME_API_KEY: The API key for your WakaTime account.

Q&A

Q: How often does the gist update? Can I set it manually? And can I set the forked repo to be private?

A: The gist is set to update once a day, which is the rate which the Wakatime API updates for this endpoint. You won't gain anything by increasing the rate of the scheduled task.

The forked repo can be private, but keep in mind that you'll be consuming your account's allotted GitHub Actions minutes for private repos: https://github.com/pricing