[DEPLOY] 배포

.github/workflows/Auto_PR_Setting.yml

@@ -45,7 +45,8 @@ jobs:
           LABELS=$(echo "${ISSUE_DATA}" | jq -r '.labels | join(",")')
 
           # 팀 멤버 목록을 정의하고, 할당되지 않은 멤버를 리뷰어로 추가.
-          TEAM_MEMBERS=("jaeml06" "i-meant-to-be" "eunwoo-levi" "katie424")
+          # 단, 현재 활동하지 않는 멤버는 제외. (현재 비활성 멤버 = 엘, 케이티)
+          TEAM_MEMBERS=("jaeml06" "i-meant-to-be" "useon")
           IFS=', ' read -r -a ASSIGNEE_ARRAY <<< "${ASSIGNEES}"
           REVIEWERS=()
           for MEMBER in "${TEAM_MEMBERS[@]}"; do

.github/workflows/Notion_Sync.yml

@@ -0,0 +1,32 @@
+name: Notion Sync
+
+on:
+  issues:
+    types: [opened]
+  pull_request:
+    types: [opened, reopened, closed]
+  pull_request_target: # For accessing secrets from forked repos
+    types: [opened, reopened, closed]
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: pip install requests pytz
+
+      - name: Run Notion Sync Script
+        env:
+          NOTION_TOKEN: ${{ secrets.NOTION_TOKEN }}
+          NOTION_DATABASE_ID: ${{ secrets.NOTION_DATABASE_ID }}
+          NOTION_USER_UUID_MAP: ${{ secrets.NOTION_USER_UUID_MAP }}
+          GITHUB_EVENT_PATH: ${{ github.event_path }}
+        run: python ./notion_sync.py

.github/workflows/deploy-development.yml

@@ -8,6 +8,7 @@ on:
 
 jobs:
   build-and-deploy:
+    if: github.event_name != 'pull_request' || github.event.pull_request.merged == true
     runs-on: ubuntu-latest
     environment: DEPLOY_DEV
 

.github/workflows/deploy-production.yml

@@ -8,6 +8,7 @@ on:
 
 jobs:
   build-and-deploy:
+    if: github.event_name != 'pull_request' || github.event.pull_request.merged == true
     runs-on: ubuntu-latest
     environment: DEPLOY_PROD
 

.storybook/main.ts

@@ -16,5 +16,17 @@ const config: StorybookConfig = {
   core: {
     builder: '@storybook/builder-vite',
   },
+  async viteFinal(config, { configType }) {
+    console.log(`# configType = ${configType}`);
+
+    // Storybook의 실행 모드를 테스트 모드로 고정하여
+    // msw가 잘 동작할 수 있게 준비
+    config.define = {
+      ...config.define,
+      'import.meta.env.MODE': JSON.stringify('test'),
+    };
+
+    return config;
+  },
 };
 export default config;

README.md

@@ -1,2 +1,83 @@
-# debate-timer-fe
-디베이트 타이머 프론트엔드 레포지토리입니다
+# ⏲️ 디베이트 타이머: Debate Timer (Front-end)
+
+디베이트 타이머의 Front-end 저장소입니다.  
+우리는 토론 진행을 효율적으로 돕는 서비스를 제공하는 것을 목표로 토론에 진행에 필요한 다양한 형식의 타이머를 제공해요.  
+전체 프로젝트 및 서비스 소개는 [조직 메인 페이지](https://github.com/debate-timer)에서 확인하세요.
+
+[서비스 바로가기](https://www.debate-timer.com)
+
+## 🛠️ 기술 스택
+
+| 항목          | 스택                           |
+| ------------- | ------------------------------ |
+| Core          | React, TypeScript              |
+| 빌드          | Vite                           |
+| 스타일링      | TailwindCSS v3                 |
+| 테스트        | Vitest, Storybook, MSW         |
+| 네트워킹      | Axios, TanStack Query          |
+| 린팅 / 포매팅 | ESLint, StyleLint, Prettier    |
+| CI / CD       | S3, CloudFront, Github Actions |
+| 분석          | GA4                            |
+
+---
+
+## 실행 방법
+
+```bash
+사전 준비
+Node.js: v20.x LTS
+패키지 매니저: npm
+
+# 의존성 설치
+npm install
+
+# 개발 서버 실행
+npm run dev
+
+# 테스트 실행
+npm run test
+
+# Storybook 실행
+npm run storybook
+
+# 빌드
+npm run build
+```
+
+---
+
+## 배포
+
+- AWS S3 + CloudFront를 사용하여 웹사이트 호스팅
+- GitHub Actions를 이용해 main 브랜치에 푸시 시 자동 배포
+
+---
+
+## 브랜치 전략
+
+- main: 배포용 안정화 브랜치
+- develop: 개발 중인 기능 통합 브랜치
+- feature/\*: 각 기능별 작업 브랜치
+
+---
+
+## 기여자
+
+### 현재 활동 중
+
+|                                                                                         **썬데이**                                                                                         |                                                                                          **치코**                                                                                           |                                                                                             **숀**                                                                                             |
+| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+| <a href="https://github.com/useon" target="_blank"><img src="https://avatars.githubusercontent.com/u/74897720?v=4" width="150" height="150" style="border-radius: 50%;" alt="썬데이"/></a> | <a href="https://github.com/jaeml06" target="_blank"><img src="https://avatars.githubusercontent.com/u/107801932?v=4" width="150" height="150" style="border-radius: 50%;" alt="치코"/></a> | <a href="https://github.com/i-meant-to-be" target="_blank"><img src="https://avatars.githubusercontent.com/u/77564014?v=4" width="150" height="150" style="border-radius: 50%;" alt="숀"/></a> |
+
+### 휴식 중
+
+|                                                                                            **엘**                                                                                             |                                                                                          **케이티**                                                                                           |
+| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+| <a href="https://github.com/eunwoo-levi" target="_blank"><img src="https://avatars.githubusercontent.com/u/162898956?v=4" width="150" height="150" style="border-radius: 50%;" alt="엘"/></a> | <a href="https://github.com/katie424" target="_blank"><img src="https://avatars.githubusercontent.com/u/80771814?v=4" width="150" height="150" style="border-radius: 50%;" alt="케이티"/></a> |
+
+---
+
+## 추가 링크
+
+- Backend Repository: <https://github.com/debate-timer/debate-timer-be>
+- Debate Timer Organization: <https://github.com/debate-timer>

notion_sync.py

@@ -0,0 +1,230 @@
+import os
+import json
+import re
+import datetime
+import requests
+import pytz
+
+# Import envs
+NOTION_TOKEN = os.getenv("NOTION_TOKEN")
+NOTION_DATABASE_ID = os.getenv("NOTION_DATABASE_ID")
+NOTION_USER_UUID_MAP_STR = os.getenv("NOTION_USER_UUID_MAP")
+NOTION_API_URL = "https://api.notion.com/v1"
+
+# Parse GitHub ID-Notion UUID map
+if NOTION_USER_UUID_MAP_STR:
+    NOTION_USER_UUID_MAP = json.loads(NOTION_USER_UUID_MAP_STR)
+else:
+    print("NOTION_USER_UUID_MAP secret not found or empty.")
+    NOTION_USER_UUID_MAP = {}
+
+# Set header for HTTP request
+HEADERS = {
+    "Authorization": f"Bearer {NOTION_TOKEN}",
+    "Notion-Version": "2022-06-28",
+    "Content-Type": "application/json",
+}
+
+# Load GitHub event payload
+def get_github_event_payload():
+    event_path = os.getenv("GITHUB_EVENT_PATH")
+    if not event_path:
+        print("GITHUB_EVENT_PATH is not valid.")
+        return None
+    try:
+        with open(event_path, "r") as f:
+            return json.load(f)
+    except (FileNotFoundError, json.JSONDecodeError) as e:
+        print(f"Failed to read event payload: {e}")
+        return None
+
+# Find Notion DB item by GitHub issue id
+def find_notion_page_by_github_id(github_id):
+    query_url = f"{NOTION_API_URL}/databases/{NOTION_DATABASE_ID}/query"
+    payload = {
+        "filter": {
+            "property": "ID",
+            "number": {
+                "equals": github_id
+            }
+        }
+    }
+    response = requests.post(query_url, headers=HEADERS, json=payload)
+    response.raise_for_status()
+    results = response.json().get("results")
+    return results[0] if results else None
+
+# Create new Notion DB item
+def create_notion_page(title, status, github_assignee_id, github_url, github_id):
+    create_url = f"{NOTION_API_URL}/pages"
+
+    # Parse Notion user id
+    notion_user_id = NOTION_USER_UUID_MAP.get(github_assignee_id, "") if github_assignee_id else ""
+
+    # Parse current time (KST)
+    korea_timezone = pytz.timezone('Asia/Seoul')
+    current_datetime = datetime.datetime.now(korea_timezone)
+    current_datetime_str = current_datetime.isoformat()
+
+    data = {
+        "parent": {"database_id": NOTION_DATABASE_ID},
+        "properties": {
+            "이름": {
+                "title": [
+                    {
+                        "text": {
+                            "content": title
+                        }
+                    }
+                ]
+            },
+            "URL": {
+                "url": github_url
+            },
+            "상태": {
+                "select": {
+                    "name": status
+                }
+            },
+            "ID": {
+                "number": github_id
+            },
+            "생성 날짜": {
+                "date": {
+                    "start": current_datetime_str
+                }
+            }
+        }
+    }
+    if (notion_user_id):
+        data["properties"]["작업자"] = {
+                "people": [
+                    {
+                        "id": notion_user_id
+                    }
+                ]
+            }
+
+    response = requests.post(create_url, headers=HEADERS, json=data)
+    response.raise_for_status()
+    print(f"Notion item created / Title: '{title}', Status: '{status}'")
+    return response.json()
+
+# Patch Notion DB item
+def update_notion_page_status(page_id, status):
+    update_url = f"{NOTION_API_URL}/pages/{page_id}"
+    data = {
+        "properties": {
+            "상태": {
+                "select": {
+                    "name": status
+                }
+            }
+        }
+    }
+    response = requests.patch(update_url, headers=HEADERS, json=data)
+    response.raise_for_status()
+    print(f"Updated status of Notion page '{page_id}' as '{status}'")
+    return response.json()
+
+# Handle issue-related event
+def handle_issue_event(payload):
+    issue = payload.get("issue")
+    if not issue:
+        print("Issue data is not in payload.")
+        return
+
+    action = payload.get("action")
+    issue_title = issue.get("title")
+    issue_url = issue.get("html_url")
+    issue_number = issue.get("number")
+    issue_assignees = issue.get("assignees", [])
+    issue_assignee_id = issue_assignees[0].get("id") if issue_assignees else None
+
+    if action == "opened":
+        print(f"Issue opened: #{issue_number} - {issue_title}")
+        # Check duplication
+        notion_page = find_notion_page_by_github_id(issue_number)
+        if not notion_page:
+            create_notion_page(issue_title, "열림", issue_assignee_id, issue_url, issue_number)
+        else:
+            print(f"Issue #{issue_number} is already in Notion DB. This task will be skipped.")
+    else:
+        print(f"Not supported action: {action}")
+
+# Handle PR event
+def handle_pull_request_event(payload):
+    pr = payload.get("pull_request")
+    if not pr:
+        print("PR data is not in payload.")
+        return
+
+    action = payload.get("action")
+    pr_title = pr.get("title")
+    pr_number = pr.get("number")
+    pr_url = pr.get("html_url")
+    pr_assignees = pr.get("assignees", [])
+    pr_assignee_id = pr_assignees[0].get("id") if pr_assignees else None
+
+    # Find all related issue ID
+    body = pr.get("body", "")
+    issue_ids = re.findall(r"(?:close|closes|closed|fix|fixes|fixed)\s+#(\d+)", body, re.IGNORECASE)
+    issue_ids = [int(num) for num in issue_ids]
+
+    # If no specified issue, create Notion DB item with PR id 
+    if not issue_ids:
+        print(f"Cannot find related issue numbers in PR #{pr_number}. Add PR id itself on the list.")
+        issue_ids = [pr_number]
+
+    for related_issue_number in issue_ids:
+        notion_page = find_notion_page_by_github_id(related_issue_number)
+
+        if not notion_page:
+            # There is no related issue on Notion or have to add PR itself 
+            if related_issue_number == pr_number: # Register PR itself
+                print(f"Add PR #{pr_number} on the Notion DB.")
+                create_notion_page(f"PR: {pr_title}", "병합 요청됨", pr_assignee_id, pr_url, pr_number)
+            else:
+                print(f"Issue #{related_issue_number} is not in Notion DB. Create new one.")
+                create_notion_page(f"이슈 #{related_issue_number} (PR 연동)", "병합 요청됨", pr_assignee_id, pr_url, related_issue_number)
+            continue
+
+        page_id = notion_page["id"]
+
+        if action == "opened" or action == "reopened":
+            print(f"PR opened/reopened: #{pr_number} - {pr_title}. Change status of related issue #{related_issue_number}.")
+            update_notion_page_status(page_id, "병합 요청됨")
+        elif action == "closed":
+            if pr.get("merged"):
+                print(f"PR merged: #{pr_number} - {pr_title}. Change status of related issue #{related_issue_number}.")
+                update_notion_page_status(page_id, "병합됨")
+            else:
+                print(f"PR closed (not merged): #{pr_number} - {pr_title}. Change status of related issue #{related_issue_number}.")
+                update_notion_page_status(page_id, "닫힘")
+        else:
+            print(f"Not supported PR action: {action}")
+
+if __name__ == "__main__":
+    event_payload = get_github_event_payload()
+
+    if not event_payload:
+        print("Cannot read event payload. Terminate.")
+    else:
+        event_name = os.getenv("GITHUB_EVENT_NAME")
+        print(f"GitHub Event Name: {event_name}")
+
+        try:
+            if event_name == "issues":
+                handle_issue_event(event_payload)
+            elif event_name == "pull_request" or event_name == "pull_request_target":
+                handle_pull_request_event(event_payload)
+            else:
+                print(f"Not supported GitHub event: {event_name}")
+        except requests.exceptions.RequestException as e:
+            print(f"Notion API request error: {e}")
+            if e.response:
+                print(f"Failure response: {e.response.text}")
+            exit(1)
+        except Exception as e:
+            print(f"Unpredicted error occured: {e}")
+            exit(1)