Skip to content

# ci/docs: GitHub Actions CI 워크플로우 추가 및 README 배지/테스트 안내 업데이트 - #9

Merged
NewEgoDoc merged 1 commit into
mainfrom
chore/add-github-actions-ci
May 6, 2026
Merged

# ci/docs: GitHub Actions CI 워크플로우 추가 및 README 배지/테스트 안내 업데이트#9
NewEgoDoc merged 1 commit into
mainfrom
chore/add-github-actions-ci

Conversation

@NewEgoDoc

Copy link
Copy Markdown
Owner

Summary

GitHub Actions 기반 CI를 추가해 main push/PR 시 ./gradlew build를 자동 실행하도록 구성했습니다. 또한 README에 CI 배지와 테스트 실행 안내를 추가해 로컬/원격 검증 경로를 명확히 했습니다.


Changes

1. CI 워크플로우 추가

  • .github/workflows/ci.yml (신규)
    • 트리거:
      • push to main
      • pull_request to main
    • 실행 환경:
      • ubuntu-latest
      • JDK 21 (temurin)
      • gradle/actions/setup-gradle@v4
    • 빌드:
      • ./gradlew --no-daemon build
    • 실패 시 테스트 리포트 아티팩트 업로드:
      • **/build/reports/tests/
      • **/build/test-results/

2. README 업데이트

  • README.md
    • GitHub Actions CI 배지 추가
    • ## 테스트 섹션 추가 (./gradlew build)
    • Testcontainers(MySQL 8 + Redis 7) 및 Docker 필요 사항 명시
    • CI에서도 동일한 Testcontainers 기반 검증 수행 내용 추가

Checklist

  • GitHub Actions CI 워크플로우 추가
  • main push/PR 자동 빌드 설정
  • 실패 시 테스트 리포트 업로드 설정
  • README CI 배지 추가
  • README 테스트 실행 가이드 추가

How to Test

# 로컬 빌드/테스트
./gradlew build
•
PR 생성 후 GitHub Actions CI 워크플로우가 자동 실행되는지 확인
•
실패 케이스에서 test-reports 아티팩트 업로드되는지 확인

### Summary

GitHub Actions 기반 CI를 추가해 `main` push/PR 시 `./gradlew build`를 자동 실행하도록 구성했습니다.
또한 README에 CI 배지와 테스트 실행 안내를 추가해 로컬/원격 검증 경로를 명확히 했습니다.

---

### Changes

#### 1. CI 워크플로우 추가

- `.github/workflows/ci.yml` (신규)
  - 트리거:
    - `push` to `main`
    - `pull_request` to `main`
  - 실행 환경:
    - `ubuntu-latest`
    - `JDK 21 (temurin)`
    - `gradle/actions/setup-gradle@v4`
  - 빌드:
    - `./gradlew --no-daemon build`
  - 실패 시 테스트 리포트 아티팩트 업로드:
    - `**/build/reports/tests/`
    - `**/build/test-results/`

#### 2. README 업데이트

- `README.md`
  - GitHub Actions CI 배지 추가
  - `## 테스트` 섹션 추가 (`./gradlew build`)
  - Testcontainers(MySQL 8 + Redis 7) 및 Docker 필요 사항 명시
  - CI에서도 동일한 Testcontainers 기반 검증 수행 내용 추가

---

### Checklist

- [x] GitHub Actions CI 워크플로우 추가
- [x] main push/PR 자동 빌드 설정
- [x] 실패 시 테스트 리포트 업로드 설정
- [x] README CI 배지 추가
- [x] README 테스트 실행 가이드 추가

---

### How to Test

```bash
# 로컬 빌드/테스트
./gradlew build
•
PR 생성 후 GitHub Actions CI 워크플로우가 자동 실행되는지 확인
•
실패 케이스에서 test-reports 아티팩트 업로드되는지 확인
@NewEgoDoc
NewEgoDoc merged commit d4b5b83 into main May 6, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant