[Github] 블로그 최신글 Github README에 올리기

Github에 README 블로그 최신글 자동화하기

Github의 README에 블로그 최신글을 자동으로 올려주는 작업을 진행할 것이다. 

과정이 매우 간단하기 때문에 빠르게 README를 꾸밀 수 있다.

 

1. RSS 피드를 가져오는 Python 코드 작성

pip install feedparser

먼저 feedparser 모듈이 필요하기 때문에 다운받아준다. 

 

내 RSS 피드 URL 확인

https://dev-wnstjd.tistory.com/rss

자신의 블로그 URL / rss 를 붙여주면 된다.

티스토리 블로그는 이렇게 하면 되고 깃허브 블로그나 벨로그 같은 경우는 다를 수 있다. 

 

2. Python 코드 작성

먼저 자신의 README 저장소에 main.py 파일을 하나 만든다. 

import feedparser
import time
URL="https://dev-wnstjd.tistory.com/rss" # URL = "내블로그 주소/rss"
RSS_FEED = feedparser.parse(URL)
MAX_POST = 5

# 기본적으로 바뀌지 않을 Markdown text 입력
markdown_text = """
<div class='blog' align='left'>
  <h2> 📖 BLOG 📖 </h2>

[![Tistory's Badge](https://github-readme-tistory-card.vercel.app/api/badge?name=준성`s블로그&theme=kakao)](https://dev-wnstjd.tistory.com)

</div>
<hr>
<div class='tech-stack' align='left'>
  <h2> 📚 TECH STACK 🛠 </h2>
  <span stye="">
  <img src="https://img.shields.io/badge/python-3776AB?style=for-the-badge&logo=python&logoColor=white">&nbsp
  <img src="https://img.shields.io/badge/node.js-339933?style=for-the-badge&logo=Node.js&logoColor=white">&nbsp
  <img src="https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white">&nbsp
  <img src="https://img.shields.io/badge/github-181717?style=for-the-badge&logo=github&logoColor=white">&nbsp
  <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black">&nbsp
  <img src="https://img.shields.io/badge/amazonaws-232F3E?style=for-the-badge&logo=amazonaws&logoColor=white">&nbsp
  </span>
<hr>

## ✅ Latest Tistory Posting<div class=blog-post text-align='left'>
"""

for idx, feed in enumerate(RSS_FEED['entries']):
    if idx > MAX_POST:
        break
    else:
        feed_date = feed['published_parsed']
        markdown_text += f" - [{feed_date.tm_mon}/{feed_date.tm_mday} - {feed['title']}]({feed['link']})\n"
markdown_text +=  """
</div>
</div>
"""
print(markdown_text)
f = open("README.md", mode="w", encoding="utf-8")
f.write(markdown_text)
f.close()

나 같은 경우는 원래 HTML 이 있었다. 그래서 아래에 이 부분을 추가해줬다. div로 닫아주지 않으면 위의 Markdown_text가 실행되지 않았다. 왜 그런지는 찾아봤는데 알 수 없다..

markdown_text는 자신의 원래 README 파일에 있던 소스를 넣으면 된다. 

markdown_text +=  """
</div>
</div>
"""

Python 코드를 분석해주는 글은 많기 때문에 찾아보길 바란다. 

이렇게 파일을 만들고 한 가지만 더 설정해주면 끝이다.

 

3. Github Actions로 일정 시간마다 업데이트 하도록 설정

Github Actions에 New workflow를 클릭하고 Python application configure 를 설정한다. 

이곳에 아래 코드를 복사를 해서 붙여 넣으면 된다. 

나도 다른 블로그에서 붙여넣기는 했는데 푸시에서 오류가 나서 확인을 해봤더니 cron 부분에서 indent를 맞추지 않아서 오류가 났다. 주의 하도록 하자.

 

# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Python application

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
  schedule:
  - cron: "0 0 */1 * *"

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python 3.9
      uses: actions/setup-python@v2
      with:
        python-version: 3.9
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install feedparser
    - name: Run Update Python Script
      run: |
        python main.py
    - name: Update README.md file
      run: |
        git pull
        git add .
        git diff
        git config --local user.email "wnstjd9701@naver.com"
        git config --local user.name "wnstjd9701"
        git commit -m "Update README.md"
        git push

마지막 git config 에는 자신의 깃허브 이메일 주소 / 깃허브 아이디를 입력하면 된다. 

 

그 후 자신의 README를 확인해 보면 잘 적용이 된 것을 확인할 수 있다.

 

- Github Action에 대해 더 알아보기

Github Action 을 적용하다가 python-application.yml에서 syntax error가 발생했다. 에러를 확인했더니 Cron 부분에서 오류가 발생하였다. 오류가 어디서 잘못된건지 구글링을 해보다가 인덴트가 맞지 오류가 발생했다. 그 뒤로 블로그 글을 올렸는데 바로 반영이 안되서 여러가지를 찾아본 결과 Cron의 역할이 바로 얼마에 한번씩 스크립트를 실행할 것인지 정하는 코드였다. 다른 블로그에서 매시간 5분 간격으로 적용하는 코드를 넣었더니 또 syntax 에러가 발생해서 원래의 시간설정으로 돌아왔다. 그리고 더 찾아보다가 시간을 계산해주는 사이르틀 찾게 되었다. 

자신의 cron 을 넣으면 바로 주기를 알려준다. 

나 같은 경우는 매일 12시am에 update가 되는것이다. (UTC이므로 한국시간 9시이다)

오늘 적용했으니 내일 오전9시에 확인을 해보도록 해야겠다. 

https://crontab.guru/#0_0_*/1_*_* 

Crontab.guru - The cron schedule expression editor

 

** 복붙하다가 파일이름이 달라서 오류가 발생했던 적도 있다..

확인 잘 하고 실행하자..