avinal/profile-readme-wakatime

Generate coding activity graph tracked by WakaTime to embed in Readme(s) and webpages.

NOTE: This project is complete and requires no additional development at this stage. If you find an issue or have ideas for new features, please open an issue. In the meantime I am trying to migrate it from Python, until that happens this is all the project has to offer.

---

If you use WakaTime to track your coding activity. You can add that to your README as a bar graph or embed in your blog/portfolio. Just add this action to any of your repository and there you have it. See mine below.

My WakaTime Coding Activity

How to add one to your README.md

1. First get your WakaTime API Key. You can get it from your WakaTime account settings.
2. Save WakaTime API Key to Repository Secret. Find that by clicking the Settings tab. Keep the name of secret as WAKATIME_API_KEY.
3. Add following line in your README.md of your repo.

<img
  src="https://github.com/<username>/<repository-name>/blob/<branch-name>/images/stat.svg"
  alt="Alternative Text"
/>
Example:
<img
  src="https://github.com/avinal/avinal/blob/main/images/stat.svg"
  alt="Avinal WakaTime Activity"
/>

You can use this method to embed in web pages too. Do not use markdown method of inserting images. It does not work some times.

4. Click Action tab and choose set up a workflow yourself.
5. Copy the following code into the opened file, you can search for WakaTime Stat in marketplace tab for assistance.

name: WakaTime status update

on:
  schedule:
    # Runs at 12 am  '0 0 * * *'  UTC
    - cron: "1 0 * * *"

jobs:
  update-readme:
    name: Update the WakaTime Stat
    runs-on: ubuntu-latest
    steps:
      # Use avinal/Profile-Readme-WakaTime@<latest-release-tag> for latest stable release
      # Do not change the line below until you have forked this repository
      # If you have forked this project you can use <username>/Profile-Readme-WakaTime@master instead
      - uses: avinal/Profile-Readme-WakaTime@master
        with:
          # WakaTime API key stored in secrets, do not directly paste it here
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
          # Automatic github token
          GITHUB_TOKEN: ${{ github.token }}
          # Branch - newer GitHub repositories have "main" as default branch, change to main in that case, default is master
          BRANCH: "master"
          # Manual Commit messages - write your own messages here
          COMMIT_MSG: "Automated Coding Activity Update :alien:"
          # Range of fetching data - default is "last_7_days". See https://wakatime.com/developers#stats for more options
          STATS_RANGE: "last_7_days"

6. Please wait till 12 AM UTC to run this workflow automatically. Or you can force run it by going to Action tab. Or you can add following lines under on: to run with every push. Search for 12 AM UTC to find equivalent time in your time zone.

on:
  push:
    branches: [master]
  schedule:
    - cron: "1 0 * * *"

profile-readme-wakatime's Issues

Only one option?

Hi I was wondering if there is support for any other embeds currently. I am using two on my personal website right now and I want to see if they can update instead of never updating!

(This image shows my two embeds that I made from 4 days ago... ) You can see this live example on my website here: https://livxy.github.io/Portfolio/public/index.html

Thanks,
Aidan

[Feature] save the pictures / data in the repo

great actions! can I have the historical data or pictures saved in the repo

Which repo to add it in?

Hey so the repo to the url and secret in are going to be the about me repo or the repo where we want the data from?

Image not updating automatically

Hi,
I have a problem with image updates with Actions -> automation seems to work - but I have to force the action manually for the image to update in my README.

It doesn't seems to work, when it's done by automation - the image just won't update.

Can you tell me what am I doing wrong. I don't think it's a bug - cause it's working fine in your README.

Thanks in advance!
Tom

Wakatime stats public and still not showing

The requested URL returned error: 403

I got this error message after following all the steps

fatal: unable to access '***github.com/jeeehaan/jeeehaan.git/': The requested URL returned error: 403
error: push error

How i solve this error?

Add a default SVG for no-coding activities

I want to add a default figure for no coding days. Suggestions are welcome.

Picture is not showing

Hey Avinal,

Thanks for creating this cool project. I just have one question: I copied the link to show the SVG picture and modified it. But it's not showing the image correctly. Can you give me a hint?