Athul Cyriac Ajay a37900c521
Merge pull request #2 from gautamkrishnar/patch-1
Added info about USERNAME in the readme
2020-07-10 18:00:51 +05:30
2020-07-10 09:49:37 +05:30
2020-07-10 09:49:37 +05:30
2020-07-10 08:20:35 +05:30
2020-07-09 21:51:43 +05:30
2020-07-10 08:20:35 +05:30
2020-07-09 21:51:43 +05:30
2020-07-09 21:51:43 +05:30
2020-07-09 21:51:43 +05:30

Dev Metrics in Readme

Wakatime Weekly Metrics on your Profile Readme

Update your Readme

Add a comment to your README like the follows

<!--START_SECTION:waka-->
<!--END_SECTION:waka-->

The lines will be our entrypoints for our metrics.

Using it

  • Get a GitHub Access Token with a repo scope and save it in the Repo Secrets GH_TOKEN = <Your GitHub Access Token>
  • Get your Wakatime API Key and save it as WAKATIME_API_KEY = <your wakatime API Key> in your Repository Secrets

That's it. The Action runs everyday at 00.00 UTC


Here is Sample Worflow File

name: Waka Readme

on:
  push:
    branches: [ master ]
  schedule:
    # Runs at 12am UTC
    - cron: '0 0 * * *'

jobs:
  build:
    runs-on: ubuntu-latest
    
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      
      - name: Update Readme
        uses: athul/waka-readme@master
        with:
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
          GH_TOKEN: ${{ secrets.GH_TOKEN}}
          USERNAME: <username> # optional, it will automaticially use the username that executing the workflow
Description
No description provided
Readme 513 KiB
Languages
Python 100%