[Git] RSS 글 발행 시(티스토리 등) GitHub 자동 커밋 방법

GitHub에서 사용자 이름(username)과 동일한 이름으로 public 레포지토리를 생성하고 RRADME.md 파일을 추가하면 프로필 페이지 상단에 README 내용이 표시된다. 프로필 페이지엔 주로 자신이 소개하고 싶은 프로젝트, 기술 스택 등을 기재한다. 카테고리별로 주목할만한 프로필 페이지를 모아둔 사이트도 있다.

 

@mokkapps

대부분의 개발자들이 블로그를 운영하고 있어서 그런지 Latest Blog Posts 헤더에 최근 글 목록을 보여주는 프로필이 많다. 이 기능은 rss-parser 같은 라이브러리를 통해 RSS 피드 목록을 불러오고 README.md에 반영하는 방식으로 구현되는데, 이 작업을 GitHub Actions를 통해 정기적으로 수행하도록 만들 수 있다.

 

 

RSS 설정

---

먼저 자신의 블로그 혹은 웹사이트에 RSS 설정을 해야 한다. RSS는 웹사이트에 올라온 정보를 간편하게 제공하기 위한 XML 기반의 포맷이다. 사용자가 직접 웹사이트를 방문하지 않아도 최신 콘텐츠를 자동으로 받을 수 있는 장점이 있다.

 

대부분의 콘텐츠 서비스는 RSS를 지원한다. 티스토리 블로그는 관리 → 블로그 → 기타 설정에서 RSS 기능을 켤 수 있다. RSS 피드는 일반적으로 도메인 주소 뒤에 /rss를 붙이는 방식으로 접근할 수 있다.

 

 

 

파싱 스크립트

---

💡 아래 가이드에선 pnpm 패키지 매니저를 사용했다.

 

프로젝트 초기화

GitHub 프로필 레포지토리를 클론한 후 아래 명령어로 프로젝트를 초기화한다.

pnpm init -y

 

명령어를 실행하면 package.json 파일이 생성된다. Node.js는 기본적으로 CommonJS(require 구문)이므로 익숙한 import 구문을 사용할 수 있도록 "type": "module"을 추가한다. 스크립트 실행을 위해 scripts 속성에 명령어도 등록해둔다.

// package.json

{
  name: "username",
  version: "1.0.0",
  description: "",
  main: "index.js",
  type: "module", // 추가
  scripts: {
    test: 'echo "Error: no test specified" && exit 1',
    "rss-to-readme": "node rss-to-readme.js", // 추가
  },
  keywords: [],
  author: "",
  license: "ISC",
};

 

RSS 피드 목록을 불러오고 자바스크립트 객체로 변환하기 위해 rss-parser 라이브러리를 설치한다.

pnpm add rss-parser

 

스크립트 작성

rss-to-readme.js 파일에 아래 내용을 붙여넣고 TODO 주석 부분을 수정한다. 기본값은 최근 5개 글을 불러와서 Latest Blog Posts 헤더(레벨2) 아래 불릿 목록으로 추가한다. 목록은 프로필 페이지 가장 하단에 위치한다.

// rss-to-readme.js

import { readFileSync, writeFileSync } from 'node:fs';
import Parser from 'rss-parser';

// Constants
const README_PATH = './README.md';
const RSS_URL = 'https://romantech.net/rss'; // TODO - 블로그 RSS 주소
const RSS_HEADERS = { Accept: 'application/rss+xml, application/xml, text/xml; q=0.1' };

const MAX_POSTS = 5; // TODO - 표시할 포스팅 개수
const HEADER_PREFIX = '##'; // TODO - 헤더 레벨
const POSTS_HEADER = `${HEADER_PREFIX} Latest Blog Posts`; // TODO - 포스팅 목록 헤더 이름
const POSTS_REGEX = new RegExp(`${POSTS_HEADER}[\\s\\S]*?(?=\\n${HEADER_PREFIX}|\\n$)`);

const parser = new Parser({ headers: RSS_HEADERS });

// RSS 피드 목록 fetching
const getRSSFeed = async (url) => await parser.parseURL(url);

// URL이 'http://'로 시작하면 'https://'로 변환
const convertToHTTPS = (url) => {
  if (url.startsWith('http://')) return url.replace('http://', 'https://');
  return url;
};

// RSS 피드 목록을 마크다운 형식으로 변환
const createPostsMarkdown = (items, count) => {
  const posts = items.slice(0, count).map(({ title, link }) => {
    return `- [${title}](${convertToHTTPS(link)})`;
  });
  return [POSTS_HEADER, ...posts].join('\n');
};

// README.md 파일 업데이트
const updateReadme = (content, newPosts) => {
  const hasPosts = content.includes(POSTS_HEADER);
  if (hasPosts) return content.replace(POSTS_REGEX, newPosts + '\n');

  return content + '\n' + newPosts;
};

// 위 3가지 작업을 모두 수행하는 함수
const refreshReadme = async () => {
  const readme = readFileSync(README_PATH, 'utf8');
  const feed = await getRSSFeed(RSS_URL);
  const newPosts = createPostsMarkdown(feed.items, MAX_POSTS);

  const updatedReadme = updateReadme(readme, newPosts);

  if (updatedReadme !== readme) {
    writeFileSync(README_PATH, updatedReadme, 'utf8');
    console.log('README.md updated successfully');
  } else {
    console.log('No new blog posts. README.md was not updated.');
  }
};

try {
  await refreshReadme();
} catch (error) {
  console.error('Error during the refresh process:', error);
  process.exit(1);
} finally {
  process.exit(0);
}

 

파일 수정을 모두 마치고 터미널에 pnpm rss-to-readme 명령어를 입력해보자. README.md 파일에 가장 최근 작성한 글 5개가 추가됐다면 성공.

 

 

GitHub Actions 워크플로우

---

GitHub Actions는 소프트웨어 개발 프로젝트의 빌드, 테스트, 배포 등을 자동화 하기 위한 CI/CD 서비스다. GitHub Actions를 이용해 주기적으로 rss-to-readme.js 스크립트를 실행하고 README.md 변경사항을 자동으로 커밋할 수 있다.

 

GitHub Actions 워크플로우는 yml 파일을 통해서 설정할 수 있으며, yml 파일은 항상 workflows 폴더에 위치해야 한다. 먼저 .github/workflows 폴더에 rss-to-readme.yml 파일을 생성한다.

📦 GitHub Profile Repository
└─ .github
   └─ workflows
      └─ rss-to-readme.yml

 

아래 내용을 붙여 넣은 후 your@email.com 부분을 GitHub에 등록한 메일 주소로 변경한다. 기본값은 매 시간 정각마다 워크플로우를 실행하도록 작성돼 있다. 원한다면 schedule: cron: 속성을 통해 변경할 수 있다. 참고로 GitHub Actions는 UTC 시간 기준이다. 특정 한국 시간으로 설정하려면 +9 시간을 추가해야 한다.

# rss-to-readme.yml

name: RSS to README

on:
  schedule:
    - cron: "0 */1 * * *" # 매 시간 정각에 실행 (UTC)
  push:
    branches:
      - main # 지정한 브랜치에 push 할 때 워크플로우 실행
  workflow_dispatch: # 수동 트리거 기능 활성

jobs:
  update-readme:
    runs-on: ubuntu-latest
    timeout-minutes: 30 # 워크플로우가 30분 내에 완료되지 않으면 자동 종료

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Node.js
        uses: actions/setup-node@v4
        with:
          node-version: lts/*

      - uses: pnpm/action-setup@v4
        name: Install pnpm and dependencies
        with:
          version: latest
          run_install: true

      - name: Update README
        run: pnpm rss-to-readme # 업데이트 스크립트 실행

      - name: Configure Git
        run: |
          git config --local user.name 'GitHub Action Bot'
          git config --local user.email 'your@email.com' # 수정

      - name: Commit and push if changed
        run: |
          # Git 저장소에 변경사항이 있을 때만 명령어 실행
          if [ -n "$(git status --porcelain)" ]; then
            git add README.md
            git commit -m "Update README with latest articles [auto-generated]" -m "Generated at: $(date -u '+%Y-%m-%d %H:%M:%S UTC')"
            git push
          else
            echo "No changes to commit"
          fi

 

위 변경 내용을 커밋하고 main 브랜치로 push 해보자. push: branches: 속성을 main으로 설정했기 때문에 push 이력을 감지해서 워크플로우가 자동으로 실행된다. 자세한 실행 과정은 Actions 탭에서 확인할 수 있다.

 

 

워크플로우를 성공적으로 수행하면 README.md 파일을 수정한 커밋이 추가된걸 확인할 수 있다.

 

 

 

GPG Signatures

---

GPG Signatures는 Git 서명 기능 중 하나로 커밋의 무결성과 신뢰성을 보장하는 기술이다. 이를 통해 커밋이 신뢰할 수 있는 출처에서 작성되었음을 확인할 수 있다. 커밋 목록에 초록색 Verified 배지가 붙으면 커밋이 유효한 GPG 키로 서명되었음을 의미한다.

 

 

GitHub Actions를 통한 커밋은 기본적으로 GPG 서명이 적용되어 있지 않기 때문에 별도 설정이 필요하다.

 

GPG Key 생성

❶ GPG 패키지 설치 (macOS 기준)

brew install gpg

 

❷ GPG 키 생성. 명령어를 실행하면 옵션 선택 질문들이 나오는데 기본값으로 설정해도 무방하다. Real name은 GitHub 사용자 이름(username), Email address는 GitHub에 등록한 이메일과 동일하게 입력 한다.

gpg --full-generate-key

# ===== 키 암호화 방식 질문 =====
# Please select what kind of key you want: (9) ECC (sign and encrypt)
# Please select which elliptic curve you want: (1) Curve 25519
# Please specify how long the key should be valid: 0 = key does not expire

# ===== 사용자 정보 질문 =====
# Real name: username
# Email address: your@email.com
# Comment: 생략가능

 

모든 정보를 입력하면 Passphrase(비밀번호)를 입력하는 팝업이 나온다. 생략할 수 있지만 보안을 위해 설정해 두는 걸 추천한다. 설정한 Passphrase는 서명을 포함한 커밋을 진행할 때 필요하므로 잘 기억해 둔다.

 

❸ GPG 키가 잘 생성됐는지 확인 (GPG 키 목록 출력)

gpg --list-keys

# pub   ed25519 2024-07-01 [SC]
#       GPG ID
# uid           [ultimate] 이름 <이메일>
# sub   cv25519 2024-07-01 [E]

 

GPG 공개키 등록

아래 명령어를 입력해서 GPG 공개키를 클립보드에 복사한다.

# your@email.com 부분은 본인 이메일 주소로 변경
gpg --armor --export your@email.com | pbcopy

 

GitHub Settings - SSH and GPG keys 페이지에서 New GPG key 버튼을 클릭한다. Title은 식별하기 쉬운 값으로 입력하고, Key 항목엔 복사한 공개키를 붙여넣는다.

 

 

Secrets 등록

이제 PG_PRIVATE_KEY, PASSPHRASE를 레포지토리 시크릿으로 등록해야 한다. 터미널에 아래 명령어를 실행해서 GPG 개인키를 클립보드에 복사해둔다.

# your@email.com 부분은 본인 이메일 주소로 변경
gpg --armor --export-secret-key your@email.com | pbcopy

 

GitHub 프로필 레포지토리 - Settings - Secrets and variables - Actions로 이동한 후 PG_PRIVATE_KEY 와 PASSPHRASE 이름의 시크릿을 추가한다. PG_PRIVATE_KEY 시크릿엔 방금 클립보드에 복사한 내용을 붙여넣으면 되고, PASSPHRASE 는 GPG Key 생성시 설정했던 비밀번호를 입력하면 된다.

 

 

위처럼 시크릿을 등록해두면 워크플로우 파일에서 ${{ secrets.GPG_PRIVATE_KEY }} 구문으로 GPG 개인키를 참조할 수 있게 된다.

 

워크플로우 수정

ghaction-import-gpg 액션을 사용하면 GPG Key를 더 쉽게 불러올 수 있다. YML 파일을 아래처럼 수정하자. your@email.com 부분은 본인 이메일 주소로 변경해준다. git commit 명령어 라인을 보면 -S 플래그가 추가됐는데, 커밋을 생성할 때 GPG 키로 서명하는 옵션이다.

# rss-to-readme.yml

name: RSS to README

on:
  schedule:
    - cron: "0 */1 * * *" # 매 시간 정각에 실행 (UTC)
  push:
    branches:
      - main # 지정한 브랜치에 push 할 때 워크플로우 실행
  workflow_dispatch: # 수동 트리거 기능 활성

jobs:
  update-readme:
    runs-on: ubuntu-latest
    timeout-minutes: 30 # 워크플로우가 30분 내에 완료되지 않으면 자동 종료

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Import GPG key
        uses: crazy-max/ghaction-import-gpg@v6
        with:
          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
          passphrase: ${{ secrets.PASSPHRASE }}
          git_user_signingkey: true
          git_commit_gpgsign: true
          git_committer_name: GitHub Action Bot
          git_committer_email: your@email.com # 수정
          trust_level: 5 # Ultimate

      - name: Install Node.js
        uses: actions/setup-node@v4
        with:
          node-version: lts/*

      - uses: pnpm/action-setup@v4
        name: Install pnpm and dependencies
        with:
          version: latest
          run_install: true

      - name: Update README
        run: pnpm rss-to-readme # 업데이트 스크립트 실행

      - name: Commit and push if changed
        run: |
          # Git 저장소에 변경사항이 있을 때만 명령어 실행
          if [ -n "$(git status --porcelain)" ]; then
            git add README.md
            git commit -S -m "Update README with latest articles [auto-generated]" -m "Generated at: $(date -u '+%Y-%m-%d %H:%M:%S UTC')"
            git push
          else
            echo "No changes to commit"
          fi

 

워크플로우 변경내용을 프로필 레포지토리에 반영하고 GitHub Actions를 통해 생성된 커밋을 확인해 보면 Verified 배지가 추가된걸 확인할 수 있다.

 

 

---

글 수정사항은 노션 페이지에 가장 빠르게 반영됩니다. 링크를 참고해 주세요