[Github Decorating] 깃허브 프로필에 WakaTime 추가하기

WakaTime은 코딩 시간을 보여주는 친구입니다. 어떤 언어를 얼마나 사용했는지 보여주는 친구로 저는 시간이 좀 짧아지는 느낌에 자극을 좀 받았습니다.

Status로 만들기

먼저 여기에 들어가셔서 Repository를 포크 해서 가져옵니다.

그다음부터는 README에 있는 내용을 차근차근 따라 하시면 됩니다.

1. Gist 만들기

https://gist.github.com/로 들어가셔서 Gist를 아무렇게나 Public으로 만들어줍니다.

그다음 https://github.com/settings/tokens/new로 들어가셔서 새 토큰을 발급해줍니다. 이때 gist를 체크해서 발급해줍니다. 이때 키를 꼭 잊어버리지 않게 주의해주세요!

2. WakaTime 계정 만들기

https://wakatime.com/signup로 들어가셔서 와카타임 계정을 만들어줍니다. 그리고 프로필에서 Display languages, editors, os, categories publicly를 꼭 체크해줍니다.

그리고 https://wakatime.com/settings/api-key에서 API 키를 발급받습니다.

3. 마무리

이제 실행을 시키면 모든 것이 완료됩니다.

아까 포크로 가져온 Repository의 .github/workflows안에 아래와 같은 schedule.yml파일이 보이실 겁니다.

name: Update gist with WakaTime stats
on:
  schedule:
    - cron: "0 0 * * *"
  # Manual triggers with workflow_dispatch
  workflow_dispatch:
jobs:
  update-gist:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: Update gist
        uses: matchai/waka-box@master
        env:
          GH_TOKEN: ${{ secrets.GH_TOKEN }}
          GIST_ID: gist.github.com들어가서 아까 만든 Gist확인후 ID입력
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}

Gist_ID만 자신의 Gist로 수정을 해주신 다음 Setting > Secret > Action로 들어가서 시크릿을 추가해줍니다. 시크릿의 이름은 GH_TOKEN과 WAKATIME_API_KEY의 이름이 똑같아야 하고 안에 내용은 아까 발급받은 토큰과 API 키를 넣어줍니다.

 

이렇게 다 한 다음 Action으로 들어가서 Update gist with WakaTime stats를 run wokrflow 하고 기다리면 끝이 납니다.

핀으로 gist를 고정한 모습

이제 아까 만든 Gist를 핀으로 고정하면 프로필에서도 WakaTime을 확인하실 수 있습니다.

README에 넣기

아까와 같이 WakaTime의 계정은 가입이 되어있어야 합니다.

그리고 이번에도 새 토큰을 만들어줍니다. 이번에는 gist가 아닌 repo와 user를 체크해줍니다.

 

그다음 프로필의 README파일에 아래의 코드를 넣어줍니다. 이 코드 사이에 WakaTime이 표시됩니다.

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

이번에도 마찬가지로 Profile Repository의 Setting > Secret > Action로 들어가서 시크릿을 추가해줍니다. 제목과 내용은 위의 방법과 동일하게 작성해줍니다.

 

이제 아까 만들어 뒀던 schedule.yml의 코드를 조금 수정해서 Action으로 바로 돌려버릴 겁니다.

name: Waka Readme

on:
  schedule:
    # Runs at 12am IST
    - cron: '30 18 * * *'
    # cron: '00 15 * * *'로 하면 한국 시간 기준으로 오전 12:00에 업데이트 된다
  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 }}
          # 플래그 자리

이렇게 작성을 하고 Action으로 와서 New Workflow > set up a workflow yourself로 들어가서 제목을 Waka Readme, 그리고 내용은 위 코드를 복붙 하셔서 넣고 Start commit 후 run workflow를 돌려버리시면 됩니다.

그러고 좀 기다리시면 프로필의 README안에 아까 적은 코드 사이로 이런 형태를 시작으로 밑으로 쭈루룩 뜨게 됩니다.

 

이상태로라면 모든 flag들이 다 출력됩니다. 엄청 길어지면서 보기 싫은 부분들도 분명히 있을 겁니다.

LOCALE: "ko" #한국
SHOW_LINES_OF_CODE: "True" # or "False"
SHOW_PROFILE_VIEWS: "True" # or "False"
SHOW_DAYS_OF_WEEK: "True" # or "False"
SHOW_SHORT_INFO: "True" # or "False"
SHOW_LOC_CHART: "True" # or "False"
SHOW_PROJECTS: "True" # or "False"
SHOW_LANGUAGE_PER_REPO: "True" # or "False"

커스텀을 하고 싶으시다면 아래의 코드를 잘 조합해서 Action으로 돌려버린 코드 안 플래그 부분에 추가해줍니다.

넣고 싶은 부분들만 넣어서 이쁘게 커스텀해보시기 바랍니다😁