This GitHub action helps to add cool dev metrics to your github profile Readme
Looking For Translation to different languages & Locale #23
Are you an early ๐ค or a night ๐ฆ?
When are you most productive during the day?
What are languages you code in?
Let's check out in your profile readme!
repo
and user
scope from here if you're running the action to get commit metrics
enabling 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.
WAKATIME_API_KEY=<your wakatime API Key>
GH_TOKEN=<your github access token>
This Action will run everyday at 00.00 IST
Add a comment to your README.md
like this:
<!--START_SECTION:waka-->
<!--END_SECTION:waka-->
waka
can be replaced by any string specified in the SECTION_NAME
flag as per (the available flags section)[#flags-available]
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.
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: Waka Readme
on:
schedule:
# Runs at 12am IST
- cron: '30 18 * * *'
workflow_dispatch:
jobs:
update-readme:
name: Update Readme with Metrics
runs-on: ubuntu-latest
steps:
- uses: anmol098/waka-readme-stats@master
with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
Actions
in your repo and select your Profile Readme Development Stats
workflow and click in Run workflow
. Now wait for a minute or two and you will see your changes.FLAGS
in your workflow file by default all flags are enabledexcept the lines of code flag due to heavy operation performed
- uses: anmol098/waka-readme-stats@master
with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
SHOW_OS: "False"
SHOW_PROJECTS: "False"
LOCALE
This Flag can be used to show stats in your language default is english uses Locale Short Hand to be passed in the flag variable example of the final result can be found here
SECTION_NAME
flag can be set to any string, and will be the name of the section to replace in the readme
COMMIT_BY_ME
flag can be set to True
to commit the code using your name and email
COMMIT_MESSAGE
flag can be set to message commit, default is "Updated with Dev Metrics"
COMMIT_USERNAME
flag can be set to username to commit the code, default is "readme-bot"
COMMIT_EMAIL
flag can be set to email to commit the code, default is "41898282+github-actions[bot]@users.noreply.github.com"
SHOW_UPDATED_DATE
flag can be set to True
to show updated date in end of paragraph
UPDATED_DATE_FORMAT
flag can be set to put updated date into a format, default is "%d/%m/%Y %H:%M:%S"
SHOW_LINES_OF_CODE
flag can be set to True
to show the Lines of code writen till date
SHOW_TOTAL_CODE_TIME
flag can be set to False
to hide Code Time
SHOW_PROFILE_VIEWS
flag can be set to False
to hide the Profile views
SHOW_COMMIT
flag can be set to False
to hide the commit stats
I'm an early ๐ค
๐ Morning 95 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 30.55%
๐ Daytime 78 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 25.08%
๐ Evening 112 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 36.01%
๐ Night 26 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 8.36%
SHOW_DAYS_OF_WEEK
flag can be set to False
to hide the commits made on different days of week
๐ I'm Most Productive on Sundays
Monday 50 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 13.19%
Tuesday 85 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 22.43%
Wednesday 56 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 14.78%
Thursday 44 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 11.61%
Friday 28 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 7.39%
Saturday 30 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 7.92%
Sunday 86 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 22.69%
SHOW_LANGUAGE
flag can be set to False
to hide the Coding Language You use
๐ฌ Languages:
JavaScript 5 hrs 26 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 61.97%
PHP 1 hr 35 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 18.07%
Markdown 1 hr 9 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 13.3%
Python 22 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 4.32%
XML 8 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 1.62%
SHOW_OS
flag can be set to False
to hide the OS details
๐ป Operating Systems:
Windows 8 hrs 46 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 100.0%
SHOW_PROJECTS
flag can be set to False
to hide the Projects worked on
๐ฑโ๐ป Projects:
ctx_connector 4 hrs 3 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 46.33%
NetSuite-Connector 1 hr 31 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 17.29%
mango-web-master 1 hr 12 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 13.77%
cable 54 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 10.41%
denAPI 40 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 7.66%
SHOW_TIMEZONE
flag can be set to False
to hide the time zone you are in
โ๏ธ Timezone: Asia/Calcutta
SHOW_EDITORS
flag can be set to False
to hide the list of code-editors used
๐ฅ Editors:
WebStorm 6 hrs 47 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 77.43%
PhpStorm 1 hr 35 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 18.07%
PyCharm 23 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 4.49%
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 Vue
Vue 8 repos โโโโโโโโโโโโโโโโโโโโโโโโโ 25.0%
Java 6 repos โโโโโโโโโโโโโโโโโโโโโโโโโ 18.75%
JavaScript 6 repos โโโโโโโโโโโโโโโโโโโโโโโโโ 18.75%
PHP 3 repos โโโโโโโโโโโโโโโโโโโโโโโโโ 9.38%
Python 2 repos โโโโโโโโโโโโโโโโโโโโโโโโโ 6.25%
Dart 2 repos โโโโโโโโโโโโโโโโโโโโโโโโโ 6.25%
CSS 2 repos โโโโโโโโโโโโโโโโโโโโโโโโโ 6.25%
SHOW_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 GitHub Data
๐ 433 Contributions in year 2020
๐ฆ Used 292.3 kB in GitHub's Storage
๐ผ Opted to Hire
๐ 25 Public Repository
๐ 15 Owned Private Repository
SHOW_LOC_CHART
flag can be set to False
to hide the Lines of code written in different quarters of different year
IGNORED_REPOS
flag can be set to "waka-readme-stats, my-first-repo"
(just an example) to ignore some repos you donโt want to be counted
SYMBOL_VERSION
flag can be set symbol for progress bar (default: 1
)
Version | Done block | Empty block |
---|---|---|
1 | โ | โ |
2 | โฃฟ | โฃ |
3 | โฌ | โฌ |
DEBUG_LOGGING
flag can be set to increase action output verbosity, by default equals internal runner debug property
Timeline
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free.
However, if you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-
Thanks! :heart:
Contributions are welcome! โฅ! Please share any features, and add unit tests! Use the pull request and issue systems to contribute.
Made with :heart: and Python ๐.