Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhance] Add source set & change directory name #10

Merged
merged 7 commits into from
Sep 16, 2024

Conversation

dojinyou
Copy link
Contributor

@dojinyou dojinyou commented Sep 16, 2024

Summary by CodeRabbit

  • 새로운 기능

    • OpenAPI 생성 구성 업데이트 및 새로운 패키지 구조 반영.
    • 생성된 Kotlin 소스 파일을 포함하는 새로운 소스 세트 추가.
    • OpenAPI 및 검증을 위한 새로운 의존성 추가.
    • GitHub Actions 워크플로우에서 서브모듈을 재귀적으로 가져오는 설정 추가.
  • 버그 수정

    • OpenAPI 생성기 설정 수정으로 코드 생성 방식 개선.

Copy link

coderabbitai bot commented Sep 16, 2024

Walkthrough

변경 사항은 build.gradle.kts 파일의 OpenAPI 생성 구성 업데이트와 새로운 의존성 추가를 포함합니다. 출력 디렉토리 경로가 변수 openApiGeneratePath로 변경되어 유지 관리가 용이해졌습니다. API 및 모델 패키지 구조가 com.threedays.oas로 업데이트되었으며, Spring Boot 3 및 Jakarta 의존성을 사용하도록 설정이 조정되었습니다. 생성된 Kotlin 소스 파일을 포함하는 새로운 소스 세트가 정의되었습니다. 또한, GitHub Actions 워크플로우에서 서브모듈을 재귀적으로 체크아웃하도록 설정이 변경되었습니다.

Changes

파일 경로 변경 요약
bootstrap/api/build.gradle.kts - outputDir${layout.buildDirectory.get()}/generated에서 openApiGeneratePath로 수정
- apiPackagecom.sc.weave2.oas.api에서 com.threedays.oas.api로 수정
- modelPackagecom.sc.weave2.oas.model에서 com.threedays.oas.model로 수정
- sourceSets 구성에 kotlin.srcDir("$openApiGeneratePath/src/main/kotlin") 추가
- OpenAPI 및 검증 관련 새로운 의존성 추가
.github/workflows/test_analyze.yaml - actions/checkout@v4 단계에 submodules: 'recursive' 추가
gradle/libs.versions.toml - swagger-annotations = "2.2.8" 추가
- springdoc-openapi-webmvc-ui 라이브러리 추가
- spring-boot-starter-validation 라이브러리 추가

Possibly related PRs

  • 👷 Sonar Cloud 추가 #6: build.gradle.kts 파일의 SonarQube 통합 관련 변경 사항이 있으며, 동일한 파일에 대한 수정이 포함되어 있습니다.

Poem

🐰 새로운 길을 가는 우리 API,
패키지 이름도 바뀌고, 더 밝은 미래.
생성된 코드가 함께하는 기쁨,
Rabbit의 마음은 항상 즐거움!
뛰어오르며 함께 나아가자,
변화는 언제나 새로운 시작이니! 🌟


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d614933 and 5c16052.

Files selected for processing (2)
  • bootstrap/api/build.gradle.kts (2 hunks)
  • gradle/libs.versions.toml (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • bootstrap/api/build.gradle.kts
Additional comments not posted (3)
gradle/libs.versions.toml (3)

37-38: 라이브러리 버전 추가가 적절해 보입니다.

swagger-annotations 라이브러리 버전 2.2.8을 추가하는 것은 프로젝트의 API 문서화 기능을 향상시키는 데 도움이 될 것 같습니다. 버전도 안정적인 릴리스 버전으로 보입니다.


81-82: API 문서화 기능 향상을 위한 라이브러리 추가가 좋아 보입니다.

springdoc-openapi-webmvc-uiswagger-annotations 라이브러리를 추가하면 Spring 기반 애플리케이션에서 OpenAPI 명세와 상호 작용하기 위한 UI를 제공하고, Swagger를 사용한 API 문서화 기능을 향상시킬 수 있을 것 같습니다. 이러한 변경은 프로젝트의 API 문서화 능력을 높이는 데 도움이 될 것입니다.


83-83: 유효성 검사 기능 추가가 유용해 보입니다.

spring-boot-starter-validation 라이브러리를 추가하면 Spring Boot 애플리케이션에서 유효성 검사를 더 쉽게 처리할 수 있습니다. 유효성 검사는 견고한 애플리케이션을 구축하는 데 중요한 측면이므로, 이 변경은 프로젝트에 도움이 될 것 같습니다.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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.
    -- Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    -- @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 generate interesting stats about this repository and render them as a table.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @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.

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 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.

bootstrap/api/build.gradle.kts Outdated Show resolved Hide resolved
bootstrap/api/build.gradle.kts Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Sep 16, 2024

@dojinyou dojinyou merged commit 8bd5e47 into main Sep 16, 2024
3 checks passed
@dojinyou dojinyou deleted the add-source-set-generate-code branch September 16, 2024 10:51
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.

2 participants