GitHub Repository 통합

📌 GitHub Repository 통합 관리

MSA의 여러 서비스 레포지토리들이 별도로 생성되어 보기에도 복잡하고 서비스간 연결되어 있는지 알 수가 없었다. 그래서 하나의 레포지토리로 보이게 하고싶었다.

 

요구사항은 아래와 같음.

• 각 서비스(주문, 상품, 유저)가 독립적으로 실행 가능하고 다른 프로젝트에 포함될 가능성이 있음.
• 커밋은 따로 하고 레포지토리 화면에서는 1개의 메인 레포지토리처럼 보이길 원함. (개별 서비스는 private해둠.)

 

🔥 서브모듈 vs 서브트리 비교

레포지토리 통합 방식은 주로 2가지를 활용하는 듯.

	서브모듈 (Submodule)	서브트리 (Subtree)
구성 방식	외부 레포를 참조 (포인터만 저장)	외부 레포를 직접 포함 (파일이 통째로 추가됨)
커밋 관리	서브모듈 내부에서 개별 커밋 필요	메인 레포에서 함께 커밋 가능
독립성	서브모듈 개별 관리, 독립성 유지	메인 레포에 포함되어 독립성이 낮음
업데이트	git submodule update로 동기화 필요	git subtree pull로 동기화 가능
사용 편의성	관리가 번거롭고 실수하기 쉬움 ⚠️	비교적 쉬움 ✅
적합한 상황	개별 프로젝트가 독립적으로 운영될 때	하나의 레포에서 전체를 함께 관리할 때

⭐ MSA에 적합한 방식은? -> 서브트리(Subtree)

1️⃣ 서브트리가 더 간편함

• 서브모듈은 각 클라이언트가 git submodule update --init을 해야 하는 불편함이 있음.
• 서브트리는 그냥 클론하면 모든 코드가 포함되어 있어서 사용하기 편리함.

2️⃣ 메인 레포에서 전체 관리 가능

• 서브트리는 서브모듈처럼 참조 방식이 아니라, 실제 코드가 포함되므로
  → 한 번의 커밋으로 모든 서비스의 변경 사항을 반영할 수 있음!
• MSA 서비스 간 버전 동기화가 쉬움 (서브모듈은 각 서브 레포를 따로 관리해야 함).

3️⃣ 외부 프로젝트에 쉽게 포함 가능 → git subtree add로 쉽게 통합 및 제거, 서브모듈도 가능하지만, 번거로움

• 서브모듈은 독립성이 높지만, 관리가 어려움 (클론 후 submodule update 필요).
• 서브트리는 단일 레포처럼 보이면서도 독립성 유지가 가능해서 운영이 편리함.

 

📌 SubTree 사용법

✅ 1. 메인 레포지토리로 만들기

깃허브에서 새 레포를 생성하고, 로컬과 연결하자.

Msa-ecommerce라는 메인 레포지토리 생성

cd msa-ecommerce
git init
git remote add origin https://github.com/{your-username}/msa-ecommerce.git

또는 github 브라우저에서 생성한 다음 clone해오기!!

 

✅ 2. 서브트리 추가하기 (subtree add)

각 MSA 서비스(order-service, product-service, user-service 등)를 서브트리로 추가한다.

git subtree add --prefix={child repository name} {child git URL} {branch}

git subtree add --prefix=gateway https://github.com/dddz/gateway.git main --squash

• --prefix=서비스명: 서브트리를 저장할 폴더
• --squash: 커밋 히스토리를 하나로 합쳐 깔끔하게 유지

 

✅ 3. 각 서비스 변경 사항 가져오기 (subtree pull)

git subtree pull --prefix={child repository name} {child git URL} {branch} --squash

 

⭐ Subtree pull 자동화 ( GitHub Actions 이용 )

자동으로 subtree 변경사항을 가지고 오고 싶다면 GitHub Actions 이용하면 된다!!

 

1️⃣ GitHub에 PERSONAL_ACCESS_TOKEN 추가

1. GitHub → Settings → Developer Settings → Personal access tokens
2. 새로운 토큰을 만들고, repo 권한 부여
3. GitHub Secrets에 PERSONAL_ACCESS_TOKEN 이름으로 저장

 

2️⃣ 설정 파일 생성
메인 레포의 .github/workflows/update-subtree.yml 파일을 만들고, 아래 내용을 추가!

name: Update Subtree
on:
  schedule:
    - cron: "0 0 * * *"  # 매일 자정(UTC)에 실행 (한국 시간 오전 9시)
  push:
    branches:
      - main  # main 브랜치에 변경이 있을 때도 실행
      
jobs:
  update-subtree:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3
        with:
          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
      - name: Pull latest subtree changes
        run: |
          git config --global user.name "github-actions"
          git config --global user.email "actions@github.com"
          git checkout main
          git subtree pull --prefix=services/service-A https://github.com/your-org/service-A.git main --squash

          git add .
          git commit -m "Auto-update service-A subtree"
          git push origin main

 

📌코드 설명

✅ 자동 실행 트리거 설정 (on:)

• schedule: → 매일 자정(UTC, 한국 시간 오전 9시) 에 자동 실행
• push: → main 브랜치에 커밋이 생길 때 실행

 

✅ GitHub Actions 실행 환경 (jobs:)

• runs-on: ubuntu-latest → GitHub Actions가 Ubuntu 환경에서 실행됨

 

✅ Git 서브트리 최신 업데이트 (git subtree pull)

• git subtree pull --prefix=services/service-A https://github.com/your-org/service-A.git main --squash

3️⃣ 메인 레포에 푸시하면 자동으로 실행됨!

 

✅ 4. 개별 서비스 커밋을 원격으로 푸시하기

git subtree push --prefix={child repository name} {child git URL} {branch}

 

✅ 5. 서브트리 제거 방법 (git rm)

git rm -r --cached order
rm -rf order
git commit -m "Removed order service from subtree"

 

⭐ 일반적인 서브트리 개발 방식

1️⃣ 각 서비스(서브 레포)는 따로 클론해서 개발 & 커밋

🔹 각 서비스는 독립 실행이 가능하니까, 원본 서브 레포에서 직접 개발하고 커밋!
🔹 원본 서브 레포에서 변경 사항이 생기면 메인 레포에도 반영해야 함.

git clone https://github.com/your-org/service-A.git
cd service-A
# 개발 후 커밋 & 푸시
git add .
git commit -m "서비스 A 기능 추가"
git push origin main

2️⃣ 메인 레포에 반영하려면?

🔹 메인 레포에서도 서브트리를 pull 해서 최신화해야 함.

cd msa-ecommerce
git subtree pull --prefix=services/service-A https://github.com/your-org/service-A.git main --squash
git add .
git commit -m "서비스 A 최신화"
git push origin main