waka-box-go
A Golang implementation, see the original version waka-box
English | 简体中文
📌 ✨ For more pinned-gist projects like this one, check out: https://github.com/matchai/awesome-pinned-gists
💻 Setup
🎒 Prep work
if only want's to update a markdown,like profile README,skip step 1 and step 2.
- Create a new public GitHub Gist with name
📊 Weekly development breakdown
(https://gist.github.com/) - Create a token with the
gist
scope and copy it. (https://github.com/settings/tokens/new) - Create a WakaTime account (https://wakatime.com/signup)
- In your WakaTime profile settings (https://wakatime.com/settings/profile) ensure
Display coding activity publicly
andDisplay languages, editors, operating systems publicly
are checked. - In your account settings, copy the existing WakaTime API Key (https://wakatime.com/settings/api-key)
- For updating a markdown file,add comments to the place where you want to update in the markdown file.
<!-- waka-box start --> <!-- waka-box end -->
🚀 Project setup
-
Fork this repo
-
Edit the environment variable in
.github/workflows/schedule.yml
:For updating github profile README,you can follow waka-box.yml in YouEclipse to create a Action in your README repo.Remember it's unsafe to use token with
repo
scope for updating the repo, waka-box update the profile repo using git command in Github Action instead of using github API.-
UPDATE_OPTION: Default is
GIST
.For only update a markdown file ,set toMARKDOWN
,and ignore environment variables with prefix GIST_ below.Set toGIST_AND_MARKDOWN
updates both the gist and the markdown file. -
MARKDOWN_FILE: The filename for the markdown file.
-
GIST_ID: The ID portion from your gist url:
https://gist.github.com/YouEclipse/
9bc7025496e478f439b9cd43eba989a4
.the following are optional, thanks @AarynSmith for PR(#11)
-
GIST_BARSTYLE: Background of the progress bar. Default is "SOLIDLT" other options include "SOLIDMD", "SOLIDDK" for medium and dark backgrounds, "EMPTY" for blank background, and "UNDERSCORE" for a line along the bottom.
-
GIST_BARLENGTH: Length of the progress bar. Default is 21. Set to -1 to auto size the bar.
-
GIST_TIMESTYLE Abbreviate the time text. Default is "LONG" ( "# hrs # mins" ). "SHORT" updates the text to "#h#m".
-
-
Go to the repo Settings > Secrets
-
Add the following environment variables:
- GH_TOKEN: The GitHub token generated above.
- WAKATIME_API_KEY: The API key for your WakaTime account.
🕵️ How it works
- Get stats from WakaTime API
- Update Gist with Github API
- Use Github Actions for updating Gist
📄 License
This project is licensed under Apache-2.0