Skip to content

Wakatime Profile Stats

Actions
A GitHub Action to update your GitHub profile README with certain stats from Wakatime
v1.0.0
Latest
Star (0)

Tags

 (1)

Wakatime Profile Stats

This GitHub Action will update your README with your coding stats from Wakatime.

Example

Wakatime Stats

Setup

name: Update Readme with Metrics

on:
  schedule:
    - cron: "0 6 * * *"
  workflow_dispatch:
jobs:
  update-readme:
    name: Update Readme with Metrics
    runs-on: ubuntu-latest
    steps:
      - name: wakatime-profile-stats
        uses: ZerGo0/wakatime-profile-stats@main
        with:
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
          GH_TOKEN: ${{ secrets.GH_TOKEN }}

Secrets

  • WAKATIME_API_KEY - Required. You can get your API key from here.
  • GH_TOKEN - Required. You can get your GitHub token from here. The token should have repo scope.

ReadMe Template

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

Anything between <!--START_SECTION:waka--> and <!--END_SECTION:waka--> will be replaced by the stats. Anything else will remain as it is.

Development

The project uses make to make your life easier. If you're not familiar with Makefiles you can take a look at this quickstart guide.

Whenever you need help regarding the available actions, just use the following command.

make help

Setup

To get your setup up and running the only thing you have to do is

make all

This will initialize a git repo, download the dependencies in the latest versions and install all needed tools. If needed code generation will be triggered in this target as well.

Run

To run the application you can use the following command

make run

You can find all possible arguments above.

Test & lint

Run linting

make lint

Run tests

make test

Credits

Made with GoTemplate

Inspired by waka-readme-stats

Wakatime Profile Stats is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

A GitHub Action to update your GitHub profile README with certain stats from Wakatime
v1.0.0
Latest

Tags

 (1)

Wakatime Profile Stats is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.