Github Actions를 이용하여 서버 없이 알림 봇 만들기

TL;DR

Github의 Issue와 Actions를 활용하여, 주기적 알림 트위터 봇을 개인 서버 없이 구축해보기

도입

약 2년 전부터 랜덤 가사 봇 이라는 이름의 트위터 봇을 운영하고 있습니다. 이름에서 대강 알수 있듯이 네이버 뮤직에서 랜덤한 가사를 긁어와 포스팅하는 봇입니다.

잠시 눈 돌리면 모두 놓치겠구나
지금 내가 어디 있는지조차
잠시 쉬어가면 한참 뒤처지겠구나
아무도 날 기다려주지 않으니

나상현 - 고속도로
— 랜덤 가사 봇 (@dailylyricbot) 2019년 12월 1일

이 봇의 기능은 크게 두 가지입니다.

정기적으로 네이버 뮤직에서 가사를 긁어와서 트위터에 포스팅하기
이 때, 중복되는 곡은 제외하기

필자가 학생일 때에는 학교에서 제공해주는 서버가 있어서, 서버에 코드를 올려놓고

파이썬의 apscheduler를 이용하여 정해진 시간에 트윗을 올리기
트윗한 곡 정보는 파일에 저장하여 중복 처리

위와 같은 방식으로 봇의 기능을 구현했습니다.

그렇게 봇을 일정 기간 운영하다보니 발생하는 문제가 있었는데, 바로 종종 학교 서버가 재부팅되다보니 이때 죽은 봇을 수동으로 다시 켜주어야 한다는 것이었습니다. 관리자 권한이 없으니 재부팅시에 자동으로 다시 봇이 켜지게끔 하는 것은 어려웠습니다. 그리고 졸업이 다가오면서 학교 서버의 리소스를 더이상 사용할 수 없게되는 문제도 있었습니다. 그래서 봇을 다른 곳에 옮기기로 결정하였습니다.

🤖 봇을 어디에 올려야 할까?

그렇다면 학교 서버를 대신하여 봇을 운영할 곳을 찾아야 합니다. 우선적으로 고려해본 선택지는 다음과 같습니다.

1. 클라우드 서비스에서 가상 서버 인스턴스 구매

AWS, Azure와 같은 클라우드 서비스에서 VPS를 구매하는 방식. 그러나 하루에 겨우 2-3회 트윗을 올리는 서비스를 위해서 VPS를 구매하는 것은 과도한 낭비라고 생각되므로 기각.

2. 집에 개인 서버를 구축

집에서 24시간 돌아가는 개인 서버를 구축하는 방식. 남는 머신이 없었으므로 기각.

3. 서버리스 서비스 활용

AWS lambda나 Azure Functions와 같은 서버리스 기능을 이용하는 방법.

서버리스 환경에 트윗을 포스팅하는 코드를 올리고, 주기적으로 코드가 실행되도록 하는 방식.

그리고 중복되는 곡을 처리하기 위해서는 곡 리스트를 저장하여야 하므로, Amazon S3와 같은 스토리지 서비스를 연계하여 곡 리스트를 저장하고 업데이트하면 됩니다.

…현실적으로 괜찮은 방법이기는 한데, 약간의 마이그레이션 과정이 필요하기도 하고, 아주 적긴해도 펑션과 스토리지 비용이 발생하는 것이 번거로워서 기각.

💡 CI 서비스를 활용해보자

그러다가 생각난 것이 Travis CI, Circle CI, Github Actions와 같은 CI(continuous integration) 서비스들입니다.

CI 서비스는 일반적으로 푸시, PR와 같은 액션이 발생했을 때 정해진 동작을 수행하게끔 사용되지만, 특정 액션이 발생했을 때가 아니라 주기적으로도(Cron Jobs) 코드가 실행되도록 할 수 있습니다.

Travis CI는 일 단위의 Cron Job을 지원하고
Circle CI와 Github Actions는 일반 리눅스 cron과 유사한 문법으로 분 단위의 Cron Job을 지원한다.

이 봇은 하루에 여러 번 포스팅을 해야하므로 Travis CI는 적합하지 않았고, Circle CI의 Cron Job 기능은 이 글을 작성하는 시점 기준으로 Nightly 기능이므로, Github Actions를 활용하기로 결정하였습니다.

이것으로 정기적으로 코드를 실행하는 문제는 해결되었으니, 다음은 곡 목록을 저장하는 문제를 해결해야합니다.

📝 곡 저장은 어떻게?

이 봇을 운영하기 위해서는 곡 ID 목록을 저장할 수 있는 기능이 필요한데, 업데이트 가능한 텍스트 파일 하나만 있으면 됩니다.

코드는 Github에 올려서 관리할 것이고, Github Actions를 이용하여 주기적으로 코드를 실행시켜 트윗을 포스팅할 것이므로, 마찬가지로 Github에 곡 저장까지 할 수 있다면 관리가 아주 편할 것 같습니다.

매번 변경된 텍스트 파일을 푸시하는 것도 방법이겠지만, 그것보다는 별도로 곡 목록을 관리하고 싶었는데요. Github Issue를 사용해서 곡 목록을 관리하기로 결정했습니다.

구현

구현한 전체 코드는 여기에서 볼 수 있습니다.

트위터 API를 사용하여 트윗을 포스팅하는 파이썬 코드는 기존에 작성되어 있으니, Github Actions로 주기적으로 해당 코드를 실행하도록 만들면 됩니다.

.github/workflows/tweet.yml 파일을 생성하고 아래와 같이 작성하였습니다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# https://github.com/ryanking13/twitter-lyric-bot/blob/master/.github/workflows/tweet.yml
name: Post tweet

on:
  schedule:
  - cron: "0 6,13,23 * * *"

jobs:
  run:
    runs-on: ubuntu-latest
    
    steps:
    - uses: actions/checkout@v1
    - name: Set up Python 3.7
      uses: actions/setup-python@v1
      with:
        python-version: 3.7
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt        
    - name: Tweet
      env:
        GITHUB_ACCESS_KEY: ${{ secrets.GITHUB_ACCESS_KEY }}
        TWITTER_ACCESS_TOKEN_KEY: ${{ secrets.TWITTER_ACCESS_TOKEN_KEY }}
        TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
        TWITTER_CONSUMER_KEY: ${{ secrets.TWITTER_CONSUMER_KEY }}
        TWITTER_CONSUMER_SECRET: ${{ secrets.TWITTER_CONSUMER_SECRET }}
      run: |
                python run.py

Github Actions는 UTC를 기준으로 하므로 9시간을 빼서 계산합니다. 위 코드는 매일 8시, 15시, 22시에 실행됩니다.
파이썬 환경 세팅 후 run.py가 실행되도록 하고, 해당 스크립트는 환경변수로 제공된 트위터, Github API 키를 사용하여 트윗을 포스팅합니다.
API 키를 노출시키지 않기 위해서 secrets 환경변수 기능을 활용합니다. Github의 아래 화면에서 환경변수를 등록할 수 있습니다.

secrets

이제 주기적으로 코드를 실행하는 부분은 완성하였습니다. 다음으로 Issue에 곡 정보를 업데이트하는 기능을 구현해야 합니다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# https://github.com/ryanking13/twitter-lyric-bot/blob/master/issue.py
from github import Github
import config

g = Github(config.GITHUB_ACCESS_KEY)


def get_issue(repo_url, issue_no):
    issue = g.get_repo(repo_url).get_issue(number=issue_no)
    return issue.body


def update_issue(repo_url, issue_no, content):
    issue = g.get_repo(repo_url).get_issue(number=issue_no)
    issue.edit(body=issue.body + "\n" + content)

이 부분은 Github API의 파이썬 구현체인 PyGithub 를 활용하여 간단하게 구현하였습니다. 곡 리스트가 적힌 이슈를 읽어오고, 곡 포스팅 후 이슈를 업데이트합니다.

이제 Github에 코드를 올려놓기만 하면 자동으로 주기적으로 트윗을 포스팅하게 됩니다.

action

정해진 시간마다 실행되고 있는 Github Actions의 모습

issue

곡 목록이 이슈에 업데이트되는 모습

🛑 끝내기 전 생각해볼 거리

본래 CI 서비스는 코드에 대한 자동적인 테스트 또는 배포를 위해서 사용하는 것으로, 본 글과 같은 목적으로 CI 서비스를 활용하는 것은 좋게 생각하면 참신한 활용법이지만, 나쁘게 생각하면 일종의 어뷰징(Abusing)입니다.

이렇게 사용하나 저렇게 사용하나 CI 서버의 리소스를 사용하는 것은 똑같으니 상관없다고 생각할 수도 있겠으나, 우리가 이렇게 좋은 서비스를 현재 무료로 사용할 수 있는 것이 사람들이 긴 시간 동안 만들어온 오픈 소스 문화의 결과물이라는 점에서, 서비스를 활용하기에 앞서 한번쯤 이런 문제를 고민 해보는 것도 좋지 않을까 생각합니다.

Reference

https://github.com/ryanking13/twitter-lyric-bot