GitHub Actions로 push할 때마다 README.md 업데이트하기

그동안 코테 문제는 private 레포에 저장했었는데

22년 12월부터 public으로 알고리즘 문제 풀이 레포에 코드를 올리기 시작했다.

 

https://github.com/monzheld/Algorithms

GitHub - monzheld/Algorithms: 🐍 파이썬 알고리즘 문제 풀이 🐍

 

 

레포를 공개하다 보니 커밋할 때마다 해결한 문제 개수를 카운트해서 README.md를 자동으로 업데이트하면 좋을 것 같았다.

그래서 찾아보던 중 아주 친절하게 작성된 글을 발견해서 이 글을 참고해서 만들어봤다!

 

github actions를 활용하여 push 할 때 마다 README.md 업데이트 하는 방법! ( feat. 코딩 1일 1문제! ) 

 

 

 

자동으로 카운트 해주는 코드 작성하기

 

깃허브 레포에 utils 폴더를 만든 다음

해당 폴더에 해결한 문제 수를 자동으로 카운트해주는 count_solved_problems.py를 생성한다. 

 

from collections import defaultdict
import os
import re


def count_solved_problems():
    """사이트별 해결한 문제 개수 카운트
    
    코딩테스트 사이트별로 해결한 문제의 개수를 세는 함수입니다.
    
    name_list (list): 디렉토리명이자 코딩테스트 사이트명
    code_dict (collections.defaultdict): 사이트별로 해결한 문제의 ipynb 파일명 (default: list)
    code_cnt_info (collections.defaultdict): 사이트별로 해결한 문제의 개수 (default: 0)
    total_code_num (int): 해결한 문제의 총개수 
    
    Returns:
        total_code_num (int): 해결한 문제의 총개수 
        code_cnt_info (collections.defaultdict): 사이트별로 해결한 문제의 개수 (default: 0)
    """    
    r = [re.findall(r"^[A-Z]+", dirctory) for dirctory in os.listdir("./")]
    name_list = [dir_name[0].replace("[", "").replace("]", "") for dir_name in r if len(dir_name) > 0]
    name_list.remove("README")

    solved_problem_list = []
    code_dict = defaultdict(list) 
    code_cnt_info = defaultdict(lambda:0) 

    for name in name_list:
        code_list = [file for file in os.listdir(f"./{name}") if file.endswith(".ipynb")] 
        code_dict[name] = code_list 
        code_cnt_info[name] = len(code_list) 
        solved_problem_list += code_list 

    total_code_num = len(solved_problem_list) 

    return total_code_num, code_cnt_info


def make_count_info(total_code_num, code_cnt_info):
    """사이트별 해결한 문제 개수 정보 작성
    
    코딩테스트 사이트별로 해결한 문제의 개수 정보를 작성하는 함수입니다.
    
    Arguments:
        total_code_num (int): 해결한 문제의 총개수 
        code_cnt_info (collections.defaultdict): 사이트별로 해결한 문제의 개수 (default: 0)
    
    Returns:
        count_info (str): 사이트별 해결한 문제 개수 정보 작성
    """   
    count_info = f"### 해결한 총 문제 수 : {total_code_num}개\n"

    for k,v in code_cnt_info.items():
        temp = f"- {k} - {v}개\n"
        count_info += temp
    
    return count_info


def make_read_me(count_info):
    """README.md 파일 작성
    
    README.md 파일을 작성하는 함수입니다.
    
    Arguments:
        count_info (str): 사이트별 해결한 문제 개수 정보 작성
        
    Returns:
        README.md 파일에 작성될 출력문
    """   

    return f"""# Algorithms
파이썬 알고리즘 문제 풀이
### Since 2022.12.13 ~
{count_info}
[알고리즘 문제 풀이 블로그](url)
#### 모든 문제는 Python3 로 해결했습니다.
"""


def update_readme_md():
    """README.md 파일 업데이트
    
    README.md 파일을 업데이트하는 함수입니다.
    
    Returns:
        README.md 파일에 작성될 출력문
    """   
    total_code_num, code_cnt_info = count_solved_problems()

    count_info = make_count_info(total_code_num=total_code_num, code_cnt_info=code_cnt_info)

    readme = make_read_me(count_info=count_info)

    return readme


if __name__ == "__main__":
    readme = update_readme_md()
    with open("./README.md", 'w', encoding='utf-8') as f:
        f.write(readme)

 

원래는 PROGRAMMERS 폴더 안에 레벨별로 따로 폴더로 구분했었는데 

이렇게 하면 해결한 문제의 ipynb 파일들을 가져오기가 너무 복잡해져서 레벨 폴더는 없애고 그냥 코딩테스트 사이트별로만 디렉토리를 나눴다.

 

그리고 참고로 make_read_me() 함수가 return할 출력문 부분은 코드에 나와있는 대로 들여 쓰기를 하지 않아야 

마크다운이 제대로 적용돼서 README.md 파일에 나온다!

 

 

 

GitHub Actions 설정하기

 

Actions의 Python application을 활용해서 workflow 코드를 작성하면 된다.

 

# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: Python application

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]


jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python 3.10
      uses: actions/setup-python@v3
      with:
        python-version: "3.10"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
    - name: Run count_solved_problems.py
      run: |
        python utils/count_solved_problems.py
    - name: Update README.md file
      run: |
        git config --local user.email "{메일 주소}"
        git config --local user.name "{user name}" 
        git status
        git add README.md
        git diff
        git commit -m "docs: Update README.md file"
        git push

 

코드 자체는 간단한데 

처음에 계속 같은 에러로 7번이나 실패했었다... 😅 (위에 나온 코드는 성공한 코드!)

 

 

 

계속 Error: Process completed with exit code 128. 에러가 났는데

 

The requested URL returned error: 403 의 해결 방법도 시도해 보고, 

Personal access tokens의 scope도 변경해보고 했지만 해결되지 않았다.

 

 

• 참고했던 The requested URL returned error: 403 해결 방법

https://velog.io/@arthur/GitHub-%EC%97%90%EB%9F%AC-%ED%95%B4%EA%B2%B0-The-requested-URL-returned-error-403

⚠️ [GitHub] The requested URL returned error: 403

 

 

나중에 다시 보니 진짜 간단한 것 때문에 에러가 났던 것이었음

 

 

내가 맨 처음 작성했던 workflow 코드는 아래와 같았다

# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: Python application

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

permissions:
  contents: read

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python 3.10
      uses: actions/setup-python@v3
      with:
        python-version: "3.10"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
    - name: Run update python script
      run: |
        python utils/count_solved_problems.py
    - name: Run update README.md file
      run: |
        git config --local user.email "{메일 주소}"
        git config --local user.name "{user name}" 
        git status
        git add README.md
        git diff
        git commit -m "docs: Update README.md file"
        git push

 

저기 있는 'permissions:' 부분 때문에 계속 같은 에러가 났던 것이었다... 

 

그래서 공식 문서를 참고해서 write를 추가해 봤는데 

permissions:
  contents: read|write

 

Invalid workflow file 에러가 떴다

Invalid workflow file
The workflow is not valid. .github/workflows/python-app.yml (Line: 13, Col: 13): Unexpected value 'read|write'

 

• 참고했던 공식 문서 

https://docs.github.com/ko/actions/using-jobs/assigning-permissions-to-jobs

작업에 권한 할당 - GitHub Docs

 

 

그래서 그냥 permissions 부분을 삭제했더니 말끔하게 해결됐다..!

 

 

 

적용된 README.md 모습

 

 

! 앞으로는 actions가 변경해둔 내용을 로컬에도 반영해야 하기 때문에 먼저 pull을 하고 push를 해야 함 !

 

 

이렇게 정리하고 보니 상당히 간단해 보이지만 

성공하기까지 생각보다 험난한 과정이었다ㅋㅋㅋ 

그래도 덕분에 오늘도 많은 걸 배울 수 있었다!