Are you human π¨βπ» or like me a vampire π§?
How many projects are you working on at the same time?
What are languages you code in?
Let's check out in your profile readme!
- You need to update your markdown file(.md) with 2 comments. You can refer here for updating it.
- You'll need a WakaTime API Key. You can get that from your WakaTime Account Settings
- You can refer here, if is you're first time with WakaTime
- You'll need a GitHub API Token with
repo
anduser
scope from here if you're running the action to get commit metricsenabling the
repo
scope seems DANGEROUS
but this GitHub Action only accesses your commit timestamp and lines of code added or deleted in repository you contributed.- You can use this example to work it out
- You need to save the WakaTime API Key and the GitHub API Token in the repository secrets. You can find that in the Settings of your repository. Be sure to save those as the following.
- WakaTime API Key as
WAKATIME_API_KEY=<your wakatime API Key>
- GitHub Personal Access Token as
GH_TOKEN=<your github access token>
- WakaTime API Key as
- You can enable and disable feature options based on requirements.
This Action will run every SUNDAY at 00.00 IST
Add a comment to your README.md
like this:
<!--START_SECTION:waka-->
<!--END_SECTION:waka-->
These lines will be our entry-points for the dev metrics.
WakaTime gives you an idea of the time you really spent on coding. This helps you boost your productivity and competitive edge.
- Head over to https://wakatime.com and create an account.
- Get your WakaTime API Key from your Account Settings in WakaTime.
- Install the WakaTime plugin in your favourite editor / IDE.
- Paste in your API key to start the analysis.
You'll need to get a GitHub Access Token with a repo
and user
scope and save it in the Repo Secrets GH_TOKEN = <Your GitHub Access Token>
Here is Sample Workflow File for running it:
name: Barthachijuu Profile Stats
on:
workflow_dispatch:
schedule:
# Runs at 00:00AM UTC Every SUNDAY
- cron: '0 0 * * SUN'
jobs:
update-readme:
name: Update this repo's README
runs-on: ubuntu-latest
steps:
- uses: barthachijuu/waka-profile-stats@main
env:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
- Now you can commit and wait for run automatically, but you can also trigger to run it to see the result now. Just go to the
Actions
in your repo and select yourProfile Readme Development Stats
workflow and click inRun workflow
. Now wait for a minute or two and you will see your changes.
- If you want to add the other info to your stats, you can add multiple
FLAGS
in your workflow file by default all flags are enabled
except the lines of code flag due to heavy operation performed
- uses: barthachijuu/waka-profile-stats@main
env:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
SHOW_OS: "False"
SHOW_PROJECTS: "False"
INPUT_COMMIT_MESSAGE
flag can be to set message commit, default is "Updated Readme with Waka Stats"
SHOW_UPDATED_DATE
flag can be set to True
to show updated date in end of paragraph
SHOW_TOTAL_TIME
flag can be set to True
to show the total time you have coded
SHOW_PROFILE
flag can be set to False
to hide the Profile views
SHOW_COMMIT
flag can be set to False
to hide the commit stats
π Maybe i am a vampire π§
π Morning 0 commits βββββββββββββββββββββββββ 0%
π Daytime 22 commits ββββββββββββββββββββββββ 41.51%
π Evening 31 commits ββββββββββββββββββββββββ 58.49%
π Night 0 commits βββββββββββββββββββββββββ 0%
SHOW_WEEK
flag can be set to False
to hide the commits made on different days of week
π I do my best effort on Thursday
Monday 8 commits βββββββββββββββββββββββ 9.76%
Tuesday 5 commits ββββββββββββββββββββββββ 6.1%
Wednesday 16 commits ββββββββββββββββββββββββ 19.51%
Thursday 37 commits ββββββββββββββββββββββββ 45.12%
Friday 16 commits ββββββββββββββββββββββββ 19.51%
Saturday 0 commits βββββββββββββββββββββββββ 0%
Sunday 0 commits βββββββββββββββββββββββββ 0%
SHOW_LANGUAGE
flag can be set to False
to hide the Coding Language You use
π·οΈ Languages
JavaScript 13 hrs 2 mins ββββββββββββββββββββββββ 96.24%
Markdown 28 mins βββββββββββββββββββββββββ 3.54%
Bash 1 min βββββββββββββββββββββββββ 0.21%
JSON 0 secs βββββββββββββββββββββββββ 0.01%
SHOW_EDITORS
flag can be set to False
to hide the list of code-editors used
π§° Editors
VS Code 13 hrs 32 mins βββββββββββββββββββββββββ 100%
SHOW_OS
flag can be set to False
to hide the OS details
π Operating System
Linux 13 hrs 32 mins βββββββββββββββββββββββββ 100%
SHOW_PROJECTS
flag can be set to False
to hide the Projects worked on
π» Projects
waka-profile-stats 13 hrs 32 mins βββββββββββββββββββββββββ 100%
SHOW_LANGUAGE_PER_REPO
flag can be set to False
to hide the Number of repository in different language and frameworks
I Mostly Code in CSS
CSS 1 repo ββββββββββββββββββββββββ 16.67%
JavaScript 1 repo ββββββββββββββββββββββββ 16.67%
Java 1 repo ββββββββββββββββββββββββ 16.67%
SCSS 1 repo ββββββββββββββββββββββββ 16.67%
SHORT_INFO
flag can be set to False
to hide the short fun fact info of user
This section requires personal access token with user permission otherwise data shown will be incorrect here
π€ My Personal GitHub Info
π 38 Personal contributions in the last year
π‘οΈ 207 Total contributions when i start a github profile
πΎ 5.86 kB Used in Github's Storage
π« Not Opted to hire
π 11 Public repos
π 3 Private repos
π 15 Followers
π 19 Following
This project is free, open source and I try to provide excellent free support. Why donate? I work on this and other project for several hours in my spare time between my job and my lovely family, and try to keep it up to date and working. THANK YOU!
Support this project by becoming a sponsor. π Become a sponsor on patreon or become top3 sponsor on ko-fi. Your logo will show up here with a link to your website.
Thank you to all our backers! π Become a backer on patreon.
Contributions are welcome! β₯!
Thanks goes to these wonderful people (emoji key):
Bartolo Amico π» π π π€ π π§ π π |
This project follows the all-contributors specification. Contributions of any kind welcome!
This project is licensed under the MIT license, Copyright (Β©) 2022 Bartolomeo Amico. For more information see LICENSE.md
- If ever you are using it right now, please tell me by sending a Special Mention issue, and I will be happy to add you to a list you will see here