티스토리 뷰

반응형

GitHub Marketplace에 GitHub App 등록하기 – 심사 통과를 위한 체크리스트

이전 글에서는 GitHub App을 SaaS 서비스 형태로 배포하고, 사용자가 설치할 수 있도록 구성하는 방법을 설명했습니다.
이번 글에서는 그 GitHub App을 GitHub Marketplace에 공식 등록하여 외부 유저들이 설치하고 사용할 수 있도록 출시하는 과정을 안내합니다.

GitHub Marketplace는 전 세계 GitHub 사용자에게 우리 App을 소개할 수 있는 공식 플랫폼입니다.
단, 등록을 위해서는 보안, UX, 문서, 기능 등 다양한 심사 항목을 통과해야 합니다.


1. GitHub Marketplace 등록 개요

반응형

항목 내용

목적 외부 사용자에게 App을 설치하게 하고, 신뢰성을 확보
대상 조직용 App 또는 퍼블릭 SaaS App
비용 무료 또는 유료(요금제 설정 가능)
필요 조건 GitHub App 등록, Webhook 처리, 설치 UI 제공, 개인정보처리방침 등

🛠️ 2. GitHub App 등록 준비사항

🔹 필수 등록 항목

항목 설명

App 이름 및 설명 명확한 목적 전달 필요 (예: "AI 기반 PR 자동화 도구")
아이콘 (SVG 권장) 깔끔한 아이콘 이미지 (예: 200x200)
설치 URL 설치 페이지로 연결되는 주소 (https://github.com/apps/{app-name}/installations/new)
Callback URL 설치 후 이동할 대시보드 주소 (/dashboard 등)
개인정보처리방침 URL SaaS 서비스 운영 시 반드시 필요
서비스 약관 URL 유료 기능 제공 시 필수

📦 3. 기능 체크리스트 (GitHub 심사 기준)

항목 필수 여부 체크

Webhook 이벤트 처리 정확성
OAuth 인증 또는 JWT 처리
사용자별 설치 정보 저장
잘못된 요청에 대한 에러 처리
모든 API 호출에 대한 로그 기록
리포지토리 범위별 권한 최소화
설정 페이지 제공 (Frontend)
보안 HTTPS 운영
SLA 및 유저 지원 수단 제공 ⚠️
GitHub Actions 또는 Apps와 혼용 가능성 안내 ⚠️

💡 심사에서는 사용자 경험, 보안, GitHub 생태계와의 조화 여부를 중요하게 평가합니다.


🧪 4. 테스트 체크포인트 (사전 QA 항목)

  • PR 생성 시 자동 라벨 부여 테스트 완료
  • 이슈 생성 시 AI 요약 작동 확인
  • 설치 후 대시보드 정상 이동
  • PR 자동 리뷰어 지정 기능 정상 작동
  • Webhook Signature 유효성 검증 정상 작동
  • Slack 연동 시 메시지 전송 테스트 완료
  • 오류 발생 시 사용자 친화적 메시지 출력

🧾 5. 개인정보 및 법적 문서 준비

문서 필수 여부 작성 팁

개인정보처리방침 (Privacy Policy) 어떤 데이터를 저장하고 어떻게 사용하는지 명시
이용 약관 (Terms of Service) 사용 범위, 금지 행위, 면책 조항 등 포함
서드파티 API 사용 명시 ⚠️ OpenAI, Slack 등 API 사용 시 설명 필요

GitHub 측에서 **"이 문서가 명확하게 작성되었는지"**를 중요하게 봅니다. Markdown 혹은 HTML 형태로 링크 제출 가능.


🚀 6. Marketplace 등록 절차

  1. GitHub Developer Settings → Your Apps → [App 이름] 클릭
  2. 하단에서 "List in Marketplace" 클릭
  3. 다음 항목 순서대로 작성:
    • 소개 문구 (짧고 명확하게!)
    • 기능 설명
    • 요금제 설정 (Free, Tiered 등)
    • 문서 링크, 고객 지원 이메일
    • 설치 URL, Redirect URL
    • 아이콘 및 이미지
  4. 제출 후 GitHub 팀에서 리뷰 (2~5일 소요)
  5. 리뷰 결과에 따라 수정 요청 또는 승인

📣 7. 승인 후 해야 할 일

  • ✅ 사용자 피드백 받을 수 있는 채널 운영 (이메일, Discord 등)
  • ✅ 에러 발생 시 알림 시스템 구축 (Slack, Sentry 등)
  • ✅ 업데이트 시 변경 사항 블로그 또는 페이지에 공유
  • ✅ GitHub Organization에 앱을 설치하고 테스트 지속

💡 8. Marketplace 등록 후 성장 전략

전략 설명

블로그 운영 GitHub App 사용법, 자동화 사례 등 지속 발행
커뮤니티 활동 Dev 커뮤니티, Reddit, Hacker News 등에 소개
SaaS 요금제 운영 월간 요금, 기능 제한 등으로 수익 모델 적용 가능
Analytics 연동 Mixpanel, Amplitude 등으로 사용 흐름 분석

🔚 9. 마무리 및 다음 글 예고

이번 글에서는 GitHub Marketplace 등록 절차와 심사 체크리스트, 제출 시 주의사항을 살펴봤습니다.
이제 여러분의 GitHub App은 단순한 자동화 도구를 넘어, 누구나 설치 가능한 SaaS 서비스로 성장할 준비가 되었습니다.

다음 글에서는
👉 "OpenAI와 GitHub App을 연동해 PR 리뷰 자동화 도우미 만들기"
실전 AI 연동 자동화 예제를 상세히 구현해 보겠습니다! 🧠🤖


 

※ 이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다.
공지사항
최근에 올라온 글
최근에 달린 댓글
Total
Today
Yesterday
링크
«   2025/04   »
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
글 보관함
반응형