/velog

velog 글 자동 업데이트

Primary LanguagePython

Velog 자동 업데이트 GitHub Actions

  • https://github.com/rimgosu/velog
  • 다음 레포지토리와 동일하게 셋팅 후, python 파일에서 자기 벨로그 주소를 적고, 권한 설정만 해주면 벨로그에 쓴 글을 자동으로 깃허브에 작성해준다.

설명

  • Velog 자동 업데이트 GitHub Actions는 GitHub Actions를 활용하여 Velog 블로그에 자동으로 글을 업데이트하는 작업을 설정한 리포지토리임
  • 이를 통해 블로그 글을 자동으로 발행하거나 특정 이벤트가 발생할 때마다 블로그를 업데이트할 수 있다.

작업 방법

1. github 새 레포지토리 만들기

  • public으로 다음과 같이 폴더를 구성해주고, github action을 위한 준비를 해주자.
your-github-repo/
├── .github/
│   └── workflows/
│       └── update_blog.yml
├── scripts/
│   └── update_blog.py
└── ...

2. github action 작성

  • update_blog.yml
name: Update Blog Posts
  

on:
  push:
      branches:
        - master  # 또는 워크플로우를 트리거하고 싶은 브랜치 이름
  schedule:
    - cron: '0 0 * * *'  # 매일 자정에 실행

jobs:
  update_blog:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v2

    - name: Push changes
      run: |
        git config --global user.name 'github-actions[bot]'
        git config --global user.email 'github-actions[bot]@users.noreply.github.com'
        git push https://${{ secrets.GH_PAT }}@github.com/rimgosu/velog.git

    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.x'

    - name: Install dependencies
      run: |
        pip install feedparser gitpython

    - name: Run script
      run: python scripts/update_blog.py
  • 매일 자정 또는 해당 레포지토리가 push 될 때 파이썬 스크립트를 실행하는 코드이다.

3. 파이썬 스크립트 작성

  • update_blog.py
import feedparser
import git
import os

# 벨로그 RSS 피드 URL
# example : rss_url = 'https://api.velog.io/rss/@rimgosu'
rss_url = 'https://api.velog.io/rss/@[벨로그 아이다]'

# 깃허브 레포지토리 경로
repo_path = '.'

# 'velog-posts' 폴더 경로
posts_dir = os.path.join(repo_path, 'velog-posts')

# 'velog-posts' 폴더가 없다면 생성
if not os.path.exists(posts_dir):
    os.makedirs(posts_dir)

# 레포지토리 로드
repo = git.Repo(repo_path)

# RSS 피드 파싱
feed = feedparser.parse(rss_url)

# 각 글을 파일로 저장하고 커밋
for entry in feed.entries:
    # 파일 이름에서 유효하지 않은 문자 제거 또는 대체
    file_name = entry.title
    file_name = file_name.replace('/', '-')  # 슬래시를 대시로 대체
    file_name = file_name.replace('\\', '-')  # 백슬래시를 대시로 대체
    # 필요에 따라 추가 문자 대체
    file_name += '.md'
    file_path = os.path.join(posts_dir, file_name)

    # 파일이 이미 존재하지 않으면 생성
    if not os.path.exists(file_path):
        with open(file_path, 'w', encoding='utf-8') as file:
            file.write(entry.description)  # 글 내용을 파일에 작성

        # 깃허브 커밋
        repo.git.add(file_path)
        repo.git.commit('-m', f'Add post: {entry.title}')

# 변경 사항을 깃허브에 푸시
repo.git.push()

4. PAT 권한 받기

  1. github 계정 - Settings - Developer Settings - Personal access tokens (classic) - Generate New Token - 이름 쓰고 repo, workflow 클릭 - Generate new token
  2. 받은 토큰 복사 (한 번 보여주고 그 뒤로 보여주지 않으므로 꼭 복사해놓자)
  3. 위에서 생성한 레포지토리 - Settings - Actions secrets and variables - Actions - New Repository Secret
  4. Name : GH_PAT, Secret : [2번에서 발급받은 토큰]

5. 커밋 또는 자정까지 기다리기

  • 레포지토리에 push를 진행하면 다음과 같이 velog-posts 폴더에 자동으로 .md 파일로 저장되는 것을 볼 수 있다.