(리드미 자동화) 파이썬 알고리즘 스니펫 생성

https://github.com/wnsgml7267/python-algorithm-snippet

GitHub - wnsgml7267/python-algorithm-snippet: (README Automation) Python Algorithm Snippets

내 깃허브 저장소에 파이썬 알고리즘 스니펫 모음을 생성했다. 동작 방식은 이러하다.

1. src 폴더에 알고리즘 폴더를 생성

2. 알고리즘 폴더에 관련된 알고리즘 파일(py)을 만들어 구현 방법을 작성한 후 push한다.

3. README.md에 자동적으로 폴더와 알고리즘 파일이 생성된다.

 

먼저, 리드미를 자동화하기 위해서는 깃허브 액션이 필요하다.

즉 OSSCA(오픈소스 컨트리뷰션 아카데미) 활동하면서도 배운 깃허브 액션에서의 CI/CD 파이프라인 구성 등 동작 방식을 연습해 보았는데 이걸 사용하려면 .github/workflows/<이름.yml> 경로에 yaml형식을 사용해야 한다.

yml 파일에서는 리드미를 자동화 할 스크립트를 push 했을 경우에 실행시키게 설정해줘야 한다.

push했을 때 실행할 스크립트에는 생성 될 폴더와 파일이 리드미에 작성 될 형식을 지정해준다.그 결과, 원하는 알고리즘 폴더와 파일을 만들어 해당 레포에  push만 해주게 되면, 아래 사진과 같이 리드미에 자동적으로 관련 내용이 생기고 클릭하면 해당 파일로 이동이 된다.

READEME.md

 

추가적으로, MIT LICENSE 를 처음으로 적용하여 보았고, 가능하면 지인과 협업하여 PR을 받아 다양한 알고리즘 스니펫을 구성해보고 싶다!

문제를 풀면서 차근차근 하나씩 늘려나갈 것!