🔧 Chore: GitHub Actions CI 파이프라인 구축

[LeeCh0129]

📌 변경 사항 개요

워크플로우 개선을 위한 GitHub Actions CI 파이프라인 구축. ESLint 자동 검사, PR 생성 시 자동으로 코드 검사를 수행하여 문제가 있는 코드의 머지를 방지하고자 함.

✨ 요약

GitHub Actions를 활용한 기본 CI 파이프라인을 구축하여 develop/main 브랜치로의 PR 및 push 시 ESLint 검사가 자동으로 실행되도록 구현했습니다. self-hosted runner 환경에서 실행되어 실제 배포 환경과 동일한 조건에서 코드 품질을 검증합니다.

📝 상세 내용

깃허브 액션 워크플로우 구성
트리거: develop/main 브랜치 PR 생성/수정 시, push 시
실행 환경: self-hosted runner (EC2 t2.micro)
타임아웃: 10분 설정

CI 파이프라인 단계

1. 코드 체크아웃: actions/checkout@v3 사용
2. Node.js 환경 설정: Node.js 18 버전, npm 캐시 활용
3. 의존성 설치: npm ci로 안정적 설치
4. ESLint 검사: 기존 설정된 ESLint 규칙으로 코드 품질 검사

활용되는 기존 설정
TypeScript, React, Next.js ESLint 규칙
TailwindCSS 검증 포함
팀 코딩 컨벤션 자동 준수 확인

🔗 관련 이슈

#31

🖼️ 스크린샷

✅ 체크리스트

• 브랜치 네이밍 컨벤션을 준수했습니다
• 커밋 컨벤션을 준수했습니다
• 코드가 프로젝트의 스타일 가이드라인을 준수합니다

💡 참고 사항

• 기존 배포 워크플로우와 일관된 환경 구성 (self-hosted)
• EC2 t2.micro 환경에서 실행되어 메모리 제약이 발생할 수 있음 : OOM Kill 발생 시 EC2 t2.small로 업그레이드 고려

Summary by CodeRabbit

• Chores
  • 새로운 GitHub Actions 워크플로우가 추가되어, 주요 브랜치에 대한 코드 린트 검사가 자동으로 실행됩니다.

[coderabbitai]

Walkthrough

새로운 GitHub Actions 워크플로우 파일이 추가되어, develop 및 main 브랜치에 대한 푸시 또는 풀 리퀘스트 시 ESLint 검사를 자동으로 실행하도록 설정되었습니다. 이 워크플로우는 코드 체크아웃, Node.js 18 환경 설정, 의존성 설치, ESLint 실행을 순차적으로 수행합니다.

Changes

파일/경로	변경 요약
.github/workflows/ci.yml	새로운 GitHub Actions 워크플로우 파일 추가, ESLint 검사 자동화 설정

Sequence Diagram(s)

sequenceDiagram
    participant GitHub
    participant Runner
    participant Node.js
    participant ESLint

    GitHub->>Runner: 워크플로우 트리거 (push/pull_request)
    Runner->>Runner: 코드 체크아웃
    Runner->>Node.js: Node.js 18 환경 설정 (npm 캐시 포함)
    Runner->>Runner: npm ci (의존성 설치)
    Runner->>ESLint: npm run lint (ESLint 검사 실행)

Loading

Possibly related issues

• 🔧 Chore: GitHub Actions CI 파이프라인 구축 #31: GitHub Actions에서 ESLint 검사 워크플로우 설정과 관련된 이슈입니다.
• 🔧 chore: GitHub Actions CI 파이프라인 구축 #30: CI 파이프라인에서 ESLint 검사 자동화와 관련된 이슈입니다.

Poem

🐇
코드 위에 바람이 분다,
ESLint가 춤을 춘다.
워크플로우가 시작되면
토끼는 귀를 쫑긋 세운다.
깔끔한 코드의 노래 속에
오늘도 CI는 달린다!
✨

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

.github/workflows/ci.yml (3)

1-2: 워크플로우 이름 명확화 제안
현재 CI Pipeline이라는 이름이 다소 일반적입니다. 예: ESLint CI 또는 Lint Check처럼 구체적으로 명시해 보세요.

---

10-12: 러너 환경 세부 지정 및 리소스 고려
runs-on: self-hosted 대신 self-hosted, linux, x64 등의 라벨을 추가해 특정 러너를 지정하는 것을 권장합니다.
또한 t2.micro 인스턴스의 메모리 제약으로 OOM이 발생할 수 있으므로, 모니터링하거나 필요 시 t2.small로 업그레이드를 검토하세요.

---

31-32: ESLint 실행 스크립트 적절
npm run lint로 팀 표준 스크립트를 호출하는 구성은 일관성이 높습니다.

옵션: npm run lint -- --max-warnings 0을 추가해 경고가 있을 경우 CI를 실패 처리하도록 설정할 수 있습니다.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ac1010e and fb96a53.

📒 Files selected for processing (1)

• .github/workflows/ci.yml (1 hunks)

🧰 Additional context used

🪛 actionlint (1.7.7)

.github/workflows/ci.yml

17-17: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

🔇 Additional comments (4)

.github/workflows/ci.yml (4)

3-8: 트리거 설정 적절
develop 및 main 브랜치에 대한 PR 생성·수정 및 push 이벤트에 대해 ESLint 검사를 자동으로 실행하도록 올바르게 구성되어 있습니다.

---

16-17: actions/checkout 버전 경고 무시 가능
static analysis 도구(actionlint)의 경고는 false positive로 보입니다. actions/checkout@v3는 현재 안정된 최신 Major 버전이므로 업데이트가 필요하지 않습니다.

🧰 Tools

🪛 actionlint (1.7.7)

17-17: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

---

20-24: Node.js 설정 및 캐시 활용 적절
Node.js 18 환경 설정과 cache: 'npm' 옵션을 통해 종속성 설치 속도를 개선한 구성이 잘 이루어졌습니다.

---

27-28: 의존성 설치 단계 문제 없음
npm ci를 사용해 일관된 방식으로 의존성을 설치하는 접근이 적합합니다.

[Insung-Jo]

고생하셨습니다! 👍 👍

[yuj2n]

수고하셨습니다~~