[Github] Notion API와 Github Actions를 이용해 Github에 올리기

나는 주로 뭔가를 정리할 때는 노션을 이용한다. 그런데 이걸 매번 일일히 마크다운으로 다운받아서 Github에 올리는 것은 매우 번거롭다. 게다가 다운받을 때 파일명이 깨져서 받아진다. 그러면 그걸 또 일일히 바꿔야 하는데..
나는 상당히 비효율적인 것을 싫어하기 때문에 방법을 찾아보았다. 그러므로 오늘은 Github Acitons를 이용해서 Github에 올리는 방법에 대해 설명하겠다.
1. Notion API를 사용하기 위한 Integration 생성.
https://developers.notion.com/

Notion API

먼저, Notion API 페이지에서 새 Integration을 생성한다. 나는 프라이빗으로 설정하였다. 저장하면 토큰이 생길 것이다. 해당 토큰은 추후에 사용해야 하니 미리 복사해둔다.
2. 공유하고자 하는 페이지에 Integration 추가

점박이 세개를 누르면 연결이라고 있다. 여기에 위에서 만든 Notion API를 연결하면 된다.
3. 스크립트 작성
Notion 데이터를 Markdown으로 변환시키는 스크립트를 작성해야 한다. 나는 Notion-to-md라는 패키지를 사용하기 위해 JavaScript로 작성하였다.
https://www.npmjs.com/package/notion-to-md/v/1.0.1

notion-to-md

import { Client } from '@notionhq/client';
import { NotionToMarkdown } from 'notion-to-md';
import { existsSync } from 'node:fs';
import { mkdirSync } from 'node:fs';
import { writeFileSync } from 'node:fs';
import dotenv from 'dotenv';

dotenv.config();
const notion = new Client({auth : process.env.NOTION_API_KEY});
const n2m = new NotionToMarkdown({ 
    notionClient: notion,
    config: {
        seperateChildPage: true,
    }
});
const databaseId = process.env.DATABASE_ID;
  
(async () => {
    try {
        const response = await notion.databases.query({
        database_id: databaseId,
        sorts: [
            {
                property: 'Name',
                direction: 'ascending',
            },
        ],
      });

      const saveDirectory = './summary';

      if (!existsSync(saveDirectory)){
        mkdirSync(saveDirectory);
      }

    const pages = response.results.map(page => {
        const pageId = page.id;
        const name = page.properties?.Name?.title?.[0]?.text?.content;
      
        return {
          pageId: pageId,
          name: name
        };
      });

      for (let page of pages){
        const mdblocks = await n2m.pageToMarkdown(page.pageId);
        const mdString = n2m.toMarkdownString(mdblocks);
        const name = page.name;
        let parts = name.split(":");
        const filePath = `${saveDirectory}/${parts[0]}-${parts[1]}.md`;
        const mdHead = `# ${page.name}\n`
        const mdContent = mdHead+ mdString.parent;
        
        writeFileSync(filePath, mdContent, "utf8");
      }
    } catch (error){
        console.error("다음과 같은 오류 발생:", error);
    }
})();

n2m.toMarkdownString(mdblocks)로 페이지의 내용을 가져온다. 이때, 디렉토리 객체이므로 mdString.parent로 가져와야한다.
custom에서 사용하고 싶다면 위 사이트를 참고해서 스크립트를 작성하면 된다. 
4. package.json 작성하기
필요한 패키지들을 정의하기 위해 package.json을 작성해야 한다. 다음과 같이 작성하면 된다.

{
  "name": "패키지명",
  "version": "1.0.0",
  "description": "패키지 설명",
  "main": "index.js",
  "type": "module",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {
  	"@notionhq/client": "^2.2.15",
    "dotenv": "^16.4.7",
    "notion-to-md": "^3.1.5"
  },
  "type": "module"
}

5. Github Action yaml 파일 작성하기

name: Convert Notion to Markdown

on:
  push:
    branches:
      - main
  schedule:
    - cron: "0 */4 * * *" # 4시간마다 실행.

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 22

      - name: Install dependencies
        run: |
          npm ci
          npm install notion-to-md

      - name: Convert Notion page to Markdown
        env:
          DATABASE_ID: ${{ secrets.DATABASE_ID }}
          NOTION_API_KEY: ${{ secrets.NOTION_API_KEY }}
          NOTION_PAGE_ID: ${{ secrets.NOTION_PAGE_ID }}
        run: |
          node convert.js
        
      - name: Check if there are any changes
        id: verify_diff
        run: |
          git diff --quiet . || echo "changed=true" >> $GITHUB_OUTPUT

      - name: Commit and push the markdown file
        if: steps.verify_diff.outputs.changed =='true'
        run: |
          git config --global user.name '5a6io'
          git config --global user.email '${{ secrets.EMAIL }}'
          git add .
          git commit -m "Update Notion page to markdown"
          git push origin main

npm init -y는 package.json을 정의한다. 그리고 notion-to-md를 필수로 설치한다. 난 환경변수를 사용하기 때문에 dotenv도 설치했다.
그리고 verify_diff에서 changed가 true라면 내용이 변한 것이 있을 때만 commit 및 push가 발생한다. 다만 처음에 푸시를 하면 빌드 오류가 발생할 것이다.

해당 레파지토리 Settings ➡️ Actions ➡️ General 하단에 보면 위와 같이 보이는 곳이 있을 것이다. 처음에는 Read repository contents adn packages permissions로 되어있다. 그러므로 우리는 쓰기도 가능하게 Read and write permissions로 바꿔줘야 한다.
6. 결과

그러면 위와 같이 변하는 것을 볼 수 있다. 코드 부분은 indent에서 저렇게 붉은 게 생기긴 하지만 그래도 나름 만족한다.

---

https://github.com/5a6io/CKA

GitHub - 5a6io/CKA: CKA 시험 대비 내용 정리

해당 repository는 위 방법을 이용해서 노션을 깃허브에 올렸다. 나는 위 패키지를 활용해 README.md도 Github Actions를 이용해서 적을 수 있도록 하였다.
그런데 사실 조금 불완전하다. README.md가 변경이 되어야지 verify_diff 부분에서 diff를 인식해서 바뀐다. 아니면 조건을 빼야 하는데 그러면 새로 바뀐 게 없을 때는 빌드 오류가 4시간 마다 일어날 것이다. 어차피 강의를 다 듣고 기록할 생각이기 때문에 나는 크게 상관이 없지만 이 부분은 나중에 해결해보겠다.

---

25.02.16 업데이트

붉게 되는 것은 노션에서 탭키를 이용하여 간격을 띄운 것이 원인이었다.