[GitHub] TIL README.md 업데이트를 자동화 해보자! (TIL README Automation)

 

TIL (Today I Learned)

말 그대로 '오늘 내가 배운 것'을 기록하는 것입니다.
부족한 점을 채우기 위해서 매일매일 꾸준히 커밋하고 있습니다.
https://github.com/DeepFlame-JR/TIL

GitHub - DeepFlame-JR/TIL: ✨Today I Learned

다만, TIL을 진행하다보면 새로운 파일을 올릴 때마다 README.md 파일을 업데이트하는 것이 상당히 귀찮습니다.
이 과정을 자동화하는 방법이 있어 소개시켜드리고자 합니다.

README.md

 

자동화 설정

방법은 GitHub Action 기능을 활용하는 것입니다.
간단하게 설명하자면 트리거를 설정하고, 해당 트리거가 발생할 시 설정한 Job을 실행하는 것입니다.
자세한 설명은 아래를 참고해주시기 바랍니다.
https://www.daleseo.com/github-actions-basics/

1. Action 정의하기

Actions > New workflow > Simple workflow 를 클릭합니다.

아래 yml을 복사합니다.

 

2. yml 파일 편집하기

해당 yml 파일을 그대로 활용하는 것이 아니라, 사용자가에게 맞게 편집해서 사용해야합니다.

• on: 트리거를 설정
  • push/branches: 브랜치에 푸시될 때 (브랜치가 master이 아닐 경우 수정 필요)
  • push/paths-ignore: 해당 파일은 트리거에서 제외
• jobs: 행위를 설정
  • description: README.md의 상단에 표시할 문구를 설정
  • list_most_recent: 표시할 가장 최근의 업데이트한 파일의 개수 설정

설정 값들을 사용자에게 맞게 수정한 뒤 파일을 생성합니다.

 

3. TIL 파일 구조 변경

위 Action이 제대로 동작하기 위해서는 신경써줘야할 부분이 있습니다.
이 부분에서 많이 해맸습니다. 😅

1. 폴더명과 파일명에 한글과 띄어쓰기가 포함되서는 안됩니다.
2. 파일의 가장 상단에 파일의 이름을 적어두어야 합니다. (Action에서는 이를 통해서 인덱싱하기 때문)
   
   

가장 상단에 파일의 이름을 적는다.

 

---

마무리

이제 모든 설정이 완료되었습니다. 커밋을 통해서 액션이 잘 동작하는지 확인해보세요! 😁

Action 실행 결과 확인 (Actions)