관련 레포

백준&프로그래머스 문제풀이 자동 관리 레포지토리

1. 들어가며

우테코를 수료한 후, 심심해서 깃허브 페이지를 꾸미려던 중 충격적인 사실을 알게 된다...

커밋 기록... 텅텅 비었다!!😂

생각해보니 억울했다. 지금까지 매일 알고리즘 문제도 풀고, 공부한 것들도 기록했기 때문이다.

알고리즘 문제 풀이는 백준, 프로그래머스에서 진행했고 공부 기록은 노션에 있다보니 실 커밋들이 일일 단위로 이뤄지지 않아 잔디가 말라 비틀어져 있었다...
(아니 물론 TIL이라 알고리즘 문풀로 커밋을 채운다는게 본말 전도같긴 한데... 다들 그렇게 하잖아요?ㅎ)

2. 백준 문제 자동 커밋

그렇다면... 알고리즘 문제를 풀 때마다 깃허브 커밋으로 남기면 되잖아?

찾아보니 마침 아름다운 플러그인이 있었다. 기존 LeetCodeHub 의 한국형 특화 플러그인인 BaekjoonHub 이다.

백준허브 플러그인

공식 사용법

이로써 깃허브에 자동 커밋이 가능해졌다! 개발자님 복받으세요🙇‍♀️

3. 기존 푼 문제들도 레포로 옮기자!🚀

기존에 풀었던 백준 문제들도 손쉽게 옮길 수 있다.
1. 플러그인 활성화 및 레포 세팅
2. 백준 마이페이지의 전체제출 업로드(표시한 부분)를 클릭
3. 기존에 푼 모든 문제들 업로드!

다만 해당 방법은 프로그래머스에선 먹히지 않았다. 프로그래머스는 따로 이미 푼 문제들을 하나씩 재 제출해야 할 것 같다.

4. 리드미를 자동으로 꾸며주자...✨

그래! 자동 커밋 연결까진 완료됐다. 앞으로의 깃헙 잔디는 푸른길만 걸을 것이다!(과연?)

하지만 아직 불편하다. 푼 문제가 푸시될 때마다 README.md가 이쁘게 관리되면 얼마나 좋을까!! 하지만 현재로썬 리드미를 수동으로 꾸며줘야만 한다.

이에 github actions로 커밋할 때마다 원하는 포맷으로 리드미를 자동 생성해주도록 설정했다.

0) GitHub Actions가 뭔데?

현재로선 이것만 알면 된다.

우리의 소중한 깃허브 알고리즘 레포에 자동 커밋될 때(특정 동작 발생)마다 (workflow에) 미리 지정된 액션이 자동 수행되는 기능

보통 플젝 CI/CD를 위해 사용하는 툴이다. 우리 속닥속닥 프로젝트에서도 사용되었었다.

1) 일단 자동생성 스크립트를 적자!

Action 탭에서 Python package를 누른다.

.github/workflows 폴더가 생겼을 것이다.

내부 yml 파일을 지우고 아무 이름이나 내가 원하는 이름의 yml 파일을 만든다.

나는 update-readme.yml 파일을 추가했다.
내용은 아래와 같다.

(주의 : build-run에서 git 유저명, 유저이메일은 각자 깃헙에 맞게 재설정이 필요합니다!!)

# 이 워크플로우는 update.py 파일을 실행합니다. 즉 README.md 파일을 업데이트합니다.

name: Update readme # GitHub Actions 탭에서 확인할 수 있는 액션 이름

on: # jobs가 실행되어야 하는 상황 정의
  push:
    branches: [ "main" ] # main 브랜치에 push가 발생했을 때
  pull_request:

jobs: # 실제 실행될 내용
  build:
    runs-on: ubuntu-latest # 빌드 환경
    steps:
    - uses: actions/checkout@v3 # checkout
    - name: Set up Python 3.10 
      uses: actions/setup-python@v3 # setup-python
      with:
        python-version: "3.10" # 3.10버전 파이썬 사용
    - name: Install dependencies # 1) 스크립트에 필요한 dependency 설치
      run: |
        python -m pip install --upgrade pip
        pip install python-leetcode 
    - name: Run update.py # 2) update.py 실행
      run: |
        python update.py
    - name: Commit changes # 3) 추가된 파일 commit
      run: |
        git config --global user.name 'BETTERFUTURE4' # 유저명
        git config --global user.email 'rerub0831@gmail.com' # 유저 이메일
        git add -A
        git commit -am "auto update README.md" # 커밋 메시지
    - name: Push changes # 4) 메인에 푸시
      run: |
        git push

2) 테이블 형태로 업데이트할래요

그리고 메인 루트쪽에 커밋 후마다 실행될 update.py 파일을 만든다.

다음은 update.py 이다.

#!/usr/bin/env python

import os
from urllib import parse

HEADER="""# 
# 백준 & 프로그래머스 문제 풀이 목록

프로그래머스의 경우, 푼 문제 목록에 대한 마이그레이션이 필요합니다.

"""

def main():
    content = ""
    content += HEADER
    
    directories = [];
    solveds = [];

    for root, dirs, files in os.walk("."):
        dirs.sort()
        if root == '.':
            for dir in ('.git', '.github'):
                try:
                    dirs.remove(dir)
                except ValueError:
                    pass
            continue

        category = os.path.basename(root)
        
        if category == 'images':
            continue
        
        directory = os.path.basename(os.path.dirname(root))
        
        if directory == '.':
            continue
            
        if directory not in directories:
            if directory in ["백준", "프로그래머스"]:
                content += "## 📚 {}\n".format(directory)
            else:
                content += "### 🚀 {}\n".format(directory)
                content += "| 문제번호 | 링크 |\n"
                content += "| ----- | ----- |\n"
            directories.append(directory)

        for file in files:
            if category not in solveds:
                content += "|{}|[링크]({})|\n".format(category, parse.quote(os.path.join(root, file)))
                solveds.append(category)
                print("category : " + category)

    with open("README.md", "w") as fd:
        fd.write(content)
        
if __name__ == "__main__":
    main()

라이브러리에 의존적이다.("백준", "프로그래머스" 등 폴더명 하드코딩ㅋㅋ)

리드미의 백준/프로그래머스 레벨별 푼 문제 목록을 테이블로 보여주도록 세팅했다.
다소 배포 속도가 느린 감은 있지만ㅎㅎ;; 일단 돌아가니까 그대로 두고 나중에 수정하려 한다.

자동 생성된 아름다운 리드미 테이블!!🥺

3) 주의사항

현재 리드미는 update.py 파일을 통해 매번 재생성되고 있다.
따라서 리드미 내용을 직접 수정하고 싶다면 README.md 파일이 아닌 update.py 파일을 수정해야 한다!
이점 잊지 말자!!!

참고자료

Github Action으로 자동으로 README.md에 링크 생성하기