Skip to content

[CHORE] JitPack 배포 관련 플러그인 설정 - #9

Merged
Jinyoung-Kim96 merged 3 commits into
devfrom
8-chore-jitpack
Apr 27, 2026
Merged

Jinyoung-Kim96 merged 3 commits into
devfrom
8-chore-jitpack

Conversation

@Jinyoung-Kim96

@Jinyoung-Kim96 Jinyoung-Kim96 commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

📝 작업 내용

이번 PR에서 작업한 내용을 설명해주세요.

  • JitPack 배포를 위한 maven-publish 플러그인 추가
  • api 의존성을 implementation으로 변경 ( 불필요한 의존성 강제 포함시키게 되므로 common 의존성 은닉 시켰습니다. )

🚀 주요 변경 사항

완료한 이슈 번호 #8
Close #8
관련된 이슈 번호 (닫고 싶지 않은 경우)
Related to #

✅ 자체 체크리스트 (필수)

  • ./gradlew build 실행 결과 정상 (인증샷 첨부)
  • Postman 테스트 완료 (인증샷 첨부)
  • 팀 내 컨벤션 준수 및 불필요한 로그, import 제거
  • 중요한 변경 사항이 팀에 공유되었는지

📸 테스트 인증샷

빌드 결과 및 Postman 실행 화면을 여기에 첨부해 주세요.

💬 리뷰어 전달사항 (선택)

특별히 봐주었으면 하는 부분이나 논의가 필요한 점을 적어주세요.

  • 논의점


📎 참고 자료

관련 문서, 레퍼런스 링크 등이 있다면 여기에 첨부해주세요.

Summary by CodeRabbit

업데이트 사항

  • 문서화

    • Gradle 의존성 설정이 유연한 버전 플레이스홀더를 사용하도록 업데이트되었습니다.
    • 버전 지정 옵션(Git 태그, 브랜치명, 커밋 해시)에 대한 설명이 추가되었습니다.
  • 기능 개선

    • Maven 출판 기능이 추가되었습니다.

@Jinyoung-Kim96 Jinyoung-Kim96 linked an issue Apr 27, 2026 that may be closed by this pull request
1 task
@coderabbitai

coderabbitai Bot commented Apr 27, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

README의 Gradle 의존성 스니펫을 하드코딩된 main-SNAPSHOT에서 구성 가능한 버전 플레이스홀더(<TAG-or-COMMIT>)로 업데이트하고, build.gradle에서 Maven 게시를 활성화하며 Spring Boot 스타터 의존성의 노출 범위를 조정합니다.

Changes

Cohort / File(s) Summary
README 문서 업데이트
README.md
Gradle 의존성 버전 플레이스홀더를 <TAG-or-COMMIT>으로 변경하고, 허용 가능한 값(Git 태그, 브랜치명, 커밋 해시) 설명 및 dev-SNAPSHOT 사용 예시 추가
Build 구성 및 Maven 게시
build.gradle
maven-publish 플러그인 적용 및 publishing 설정으로 common 발행물 추가; Spring Boot 스타터 의존성 3개를 api에서 implementation으로 변경하여 내부 의존성으로 전환; Gradle 모듈 메타데이터 검증 에러 억제 추가

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 버전 플레이스홀더, 흐릿한 경계를 선명하게,
Maven의 출판 무대를 준비하고,
의존성은 내부로 슬금슬금 숨겨지니,
JitPack 배포로 향하는 길 위에서,
우리의 패키지는 더욱 우아해진다네! 📦✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PR 제목은 변경 사항의 주요 목적인 JitPack 배포를 위한 maven-publish 플러그인 설정을 명확하게 설명하고 있습니다.
Linked Issues check ✅ Passed 변경 사항이 연결된 이슈 #8의 요구 사항인 maven-publish 플러그인 추가 및 JitPack 배포 설정을 완벽하게 충족합니다.
Out of Scope Changes check ✅ Passed README.md의 문서화 업데이트와 api에서 implementation으로의 의존성 변경은 모두 JitPack 배포 설정과 관련된 범위 내 변경입니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 8-chore-jitpack

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
build.gradle (1)

36-38: 라이브러리 모듈의 implementation 의존성 재검토 제안

이 모듈은 아직 0.0.1-SNAPSHOT (미릴리스 상태)이고 현재 깃 저장소에 소비 서비스가 없어 기존 하위 호환성 파괴 시나리오는 적용되지 않습니다. 다만, 향후 첫 릴리스 이후 의존성 구조 변경은 다음을 고려해야 합니다:

spring-boot-starter-web, spring-boot-starter-validation, spring-boot-starter-data-jpa는 소비자 서비스가 직접 사용하는 타입/어노테이션을 제공합니다 (예: @Entity, 검증 어노테이션). README에 명시된 대로 "의존만 걸면 자동 설정이 적용"되려면, 소비자가 이들 스타터를 명시적으로 재선언하지 않고도 자동 설정 기능을 활용할 수 있어야 합니다.

라이브러리 모듈의 경우 공개 API 역할을 하는 의존성은 api로 선언하는 것이 관례입니다. 현재 구조는 소비자에게 추가 build.gradle 관리 부담을 줍니다.

권장 사항:

  • spring-boot-starter-web, spring-boot-starter-validation, spring-boot-starter-data-jpaapi로 변경하면 더 나은 개발자 경험을 제공합니다.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@build.gradle` around lines 36 - 38, The build file uses implementation for
dependencies that are part of the library's public API (spring-boot-starter-web,
spring-boot-starter-validation, spring-boot-starter-data-jpa), which prevents
consumers from getting those types/annotations transitively; change those three
dependency declarations from implementation to api so consumers automatically
receive the starters (and their annotations/@Entity, validation annotations,
autoconfig behavior) without re-declaring them.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 52-57: 예제 코드 블록의 마크다운 포맷이 깨져 있으니 해당 텍스트(예: the dependencies block
containing "dependencies {" and "implementation
'com.github.Miche-Let:common:dev-SNAPSHOT'")를 ```gradle 코드 펜스로 감싸서 시작과 끝에 각각
```를 추가하고 들여쓰기 및 줄바꿈을 정리하여 코드 블록으로 렌더링되게 수정하세요; 즉, wrap the "dependencies { ...
}" snippet in a fenced code block with the language tag `gradle` and ensure the
closing fence is present.

---

Nitpick comments:
In `@build.gradle`:
- Around line 36-38: The build file uses implementation for dependencies that
are part of the library's public API (spring-boot-starter-web,
spring-boot-starter-validation, spring-boot-starter-data-jpa), which prevents
consumers from getting those types/annotations transitively; change those three
dependency declarations from implementation to api so consumers automatically
receive the starters (and their annotations/@Entity, validation annotations,
autoconfig behavior) without re-declaring them.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 618c9eb8-cdb6-4475-98d1-8700313f6bc8

📥 Commits

Reviewing files that changed from the base of the PR and between fa3720c and 857d190.

📒 Files selected for processing (2)
  • README.md
  • build.gradle

Comment thread README.md
Comment on lines +52 to +57
>
> ex )
>
> dependencies {
implementation 'com.github.Miche-Let:common:dev-SNAPSHOT'
}

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

예제 코드 블록 포맷팅이 깨져 있습니다.

예제 코드가 코드 블록 내에 포함되어 있지 않아 마크다운 렌더링 시 가독성이 떨어집니다.

📝 포맷팅 수정 제안
 > `<TAG-or-COMMIT>` 는 깃 태그(`v0.0.1` 등), 브랜치(`main-SNAPSHOT`), 또는 커밋 해시.
->
-> ex )
-> 
-> dependencies {
-implementation 'com.github.Miche-Let:common:dev-SNAPSHOT'
-}
+>
+> 예시:
+> ```gradle
+> dependencies {
+>     implementation 'com.github.Miche-Let:common:dev-SNAPSHOT'
+> }
+> ```
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 52 - 57, 예제 코드 블록의 마크다운 포맷이 깨져 있으니 해당 텍스트(예: the
dependencies block containing "dependencies {" and "implementation
'com.github.Miche-Let:common:dev-SNAPSHOT'")를 ```gradle 코드 펜스로 감싸서 시작과 끝에 각각
```를 추가하고 들여쓰기 및 줄바꿈을 정리하여 코드 블록으로 렌더링되게 수정하세요; 즉, wrap the "dependencies { ...
}" snippet in a fenced code block with the language tag `gradle` and ensure the
closing fence is present.

@githyj-jang githyj-jang left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

확인했습니다!

@jihxonx jihxonx left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

확인했습니다!

@qldo qldo left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

확인하였습니다!

@Jinyoung-Kim96
Jinyoung-Kim96 merged commit aaf3b1d into dev Apr 27, 2026
3 of 4 checks passed
@Jinyoung-Kim96
Jinyoung-Kim96 deleted the 8-chore-jitpack branch April 27, 2026 06:08
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.

[CHORE] JitPack 배포 관련 플러그인 설정

4 participants