🌳 velog 포스팅으로 github에 잔디심기

😭 폴더 생성과 파일생성까지는 어렵지 않아요!! 그런데 정말 많은 시간을 소비했던 Permission 에러... 어떻게 해결했을까요!!

📎 Reference
✔ velog와 github 연동 : 벨로그 글쓰고 잔디심기 🌱
✔ velog 글 작성 시, 자동으로 github에 커밋하기
✔ Permission denied to github-actions[bot]

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

📌 public으로 생성

2. 레포지토리에 폴더 및 파일 생성

📌.github폴더 안에 workflows/update_blog.yml 생성

velog_hub
├─ .github
|   └─ workflows
|      └─ update_blog.yml
└─ scripts
   └─ update_blog.py

3. github action

3-1. update_blog.yml 파일 생성

📌 permissions 꼭 작성해주기!! 인증문제 해결법 바로가기>>>

매일 자정 / push 될 때 파이썬 스크립트실행

name: Update Blog Posts

on:
  push:
    branches:
      - main # 또는 워크플로우를 트리거하고 싶은 브랜치 이름
  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://<username>${{ secrets.GH_PAT }}@github.com/<username>/velog_hub.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

    # 사용자 인증
    permissions:
      contents: write

3-2. update_blog.py 파일 생성

import feedparser
import git
import os

# 벨로그 RSS 피드 URL
# example : rss_url = 'https://api.velog.io/rss/@soozi'
rss_url = 'https://api.velog.io/rss/@<velog_아이디>'

# 깃허브 레포지토리 경로
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':sparkles: new post: {entry.title}')

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

4. PAT 권한 받기

4-1. token 생성

📌 받은 token 복사 (딱 한 번만 볼 수 있으니 반드시 복사!!!)

github 계정 -> Settings -> Developer Settings
-> Personal access tokens (classic) -> Generate New Token
-> Note 작성 -> repo, workflow 클릭 -> Generate new token

4-2. 레포지토리(velog_hub)에 secret 설정

velog_hub -> Settings -> Actions secrets and variables -> Actions -> New Repository Secret
✔ Name : GH_PAT
✔ Secret : [2번에서 발급받은 토큰]

5. 여기까지 push!

😵 그리고 장렬하게 실패

6. 해결

6-1. 원격 저장소 URL 변경

📌 권한 인증필요 - 원격 저장소 URL을 올바르게 변경해야함!!

$ git remote set-url origin https://
"user-name"@github.com/"user-name"/"repository-name".git

6-2. update_blog.yml 파일에서 github 주소 수정

run: |
   git config --global user.name 'github-actions[bot]'
   git config --global user.email 'github-actions[bot]@users.noreply.github.com'
   git push https://<USERNAME>${{ secrets.GH_PAT }}@github.com/<USERNAME>/velog_hub.git

🤢 6-2, 6-3을 시행한 결과 -> 응 또 실패야~ 또 Permission 에러

(fix: 사용자 인증 커밋은 그냥 주석만 추가한 것)

6-3. 에러 메시지에 주목하라!

remote: Permission to USERNAME/velog_hub.git denied to github-actions[bot]

📌 github-actions[bot]이 USERNAME/velog_hub.git에 접근할 권한이 없다!!
=> 그렇다면 github-actions[bot]이 접근할 권한을 설정해줘야겠네?

✨ 해결방법 1

📌 Settings -> Actions -> General 에서 Workflow Permissions 설정하기

😱 그러나 이 방법은 보안상 문제가 있음...

✨ 해결방법 2 -> 채택!!!

📌 update_blog.yml 파일에 permissions 속성 추가하기

jobs:
  update_blog:
  	...
    # 아래 내용 추가!!!
    permissions:
      contents: write

contents: write : 워크플로우가 리포지토리의 콘텐츠를 수정하고 커밋/푸시할 수 있는 권한을 가지게 됨!!

💣 차이점

Workflow Permissions 설정	permissions 속성 추가
레포지토리의 모든 워크플로우에 대해 일괄적으로 적용	워크플로우 파일 내에서 각 워크플로우에 대해 필요한 최소한의 권한을 개별적으로 설정. 따라서 필요하지 않은 권한을 부여하지 않음으로써 보안 강화

7. 성공!!!!

8. 후기

다음포스팅에 계속...