개발자라면 자신의 GitHub 프로필에서 어떤 기여를 했는지, 특히 비공식적인 저장소에서도 얼마나 많은 작업을 했는지 궁금할 것입니다. 하지만 기본적으로 제공되는 GitHub 통계는 공개 저장소의 기여만을 반영하므로, 실제 기여도와는 차이가 클 수 있습니다. 이러한 문제를 해결하기 위해 등장한 프로젝트가 바로 GitHub Stats Visualization입니다. 이 도구는 개인적인 통계를 시각적으로 표현하여 프로필을 더욱 매력적으로 만들 수 있도록 돕습니다.

프로젝트 개요

github-stats 프로젝트는 GitHub API를 활용하여 사용자와 저장소의 통계를 수집하고, 이를 바탕으로 이미지 형태로 시각화합니다. 이 도구의 특별한 점은 비공개 저장소의 데이터도 포함할 수 있다는 점입니다. 개발자는 GitHub Actions를 통해 이 통계들을 자동으로 갱신하며, 별도의 서버를 운영할 필요가 없습니다.

주요 기능과 특징

  1. 비공식 저장소 통계 포함: 개인이 기여한 비공식 저장소의 통계도 반영되므로, 자신의 기여도를 더 정확히 나타낼 수 있습니다.
  2. 자동 갱신: GitHub Actions를 통해 통계 이미지가 자동으로 업데이트되어 항상 최신 정보를 제공합니다.
  3. 다양한 시각화: 생성된 이미지는 GitHub의 라이트 모드와 다크 모드에 자동으로 적응합니다.
  4. JSON 데이터 출력: 시각화된 이미지를 생성하는 것뿐만 아니라, 통계 데이터를 JSON 파일로 출력하여 추가적인 데이터 분석이 가능합니다.

설치 및 기본 사용법

이제 실제로 github-stats를 설치하고 사용하는 방법을 알아보겠습니다.

1. 리포지토리 클론

먼저, github-stats 리포지토리를 클론합니다. 아래 명령어를 실행하세요.

git clone https://github.com/jstrieb/github-stats.git
cd github-stats

2. GitHub 액세스 토큰 생성

비공개 저장소의 통계도 포함하기 위해 GitHub 액세스 토큰을 생성해야 합니다. GitHub 설정에서 "Developer settings" > "Personal access tokens"로 이동하여 새로운 토큰을 생성하세요. 이 토큰은 repo 권한을 포함해야 합니다.

3. GitHub Actions 설정

리포지토리의 .github/workflows 폴더에 있는 main.yml 파일을 수정하여 액세스 토큰을 환경 변수로 설정합니다. 다음과 같은 설정을 추가해야 합니다.

env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

4. 통계 이미지 생성

GitHub Actions가 설정되면, 이제 GitHub에서 직접 통계 이미지를 생성할 수 있습니다. 리포지토리에 푸시하면 자동으로 통계가 계산되고 이미지를 생성하기 시작합니다.

5. README에 통계 이미지 추가

생성된 이미지 파일을 사용하여 README.md 파일에 추가할 수 있습니다. 예를 들어, 아래와 같이 이미지를 추가할 수 있습니다.

Overview
Languages

이렇게 하면, 프로필에서 자신의 GitHub 기여도를 한눈에 알아볼 수 있는 멋진 시각화가 완성됩니다.

실무 활용 시나리오

이 도구는 개인 개발자뿐만 아니라 팀에서도 유용하게 활용할 수 있습니다. 예를 들어, 팀 프로젝트의 기여도를 시각화하여 각 팀원의 기여를 한눈에 알아볼 수 있습니다. 이 통계 이미지는 팀이 진행하는 프로젝트의 README 파일에 추가하여 외부 사용자에게 팀의 활동을 명확히 보여줄 수 있습니다. 또한, 이 통계 데이터를 기반으로 팀 회고 시에도 유용한 토픽이 될 수 있습니다.

유사 도구 비교

비슷한 기능을 갖춘 도구로는 GitHub Readme Stats가 있습니다. 이 도구는 GitHub 통계를 시각화하는 데 초점을 두고 있지만, 비공식 저장소의 통계를 포함하지 않는다는 점에서 차별화됩니다. github-stats는 개인의 모든 기여를 반영할 수 있는 점에서 더 나은 선택일 수 있습니다.

마무리 및 추천 대상

github-stats는 개인 개발자는 물론, 팀 리더와 관리자가 자신의 및 팀원의 GitHub 기여도를 시각적으로 표현하고, 이를 통해 프로젝트의 가시성을 높일 수 있도록 돕는 유용한 도구입니다. 특히 비공식 저장소에서의 기여를 포함할 수 있는 점이 큰 장점입니다. GitHub에서 여러분의 프로필을 더욱 매력적으로 꾸며보세요!

프로젝트에 대한 더 자세한 내용은 GitHub Stats Visualization 링크를 통해 확인해보세요!