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

Maint/cleanup poms #349

Merged
merged 2 commits into from
Jan 13, 2025
Merged

Maint/cleanup poms #349

merged 2 commits into from
Jan 13, 2025

Conversation

simonhir
Copy link
Member

@simonhir simonhir commented Jan 13, 2025

Description

Cleanup poms:

  • Rm gateway release-maven-plugin submodule configuration
  • Rm integrations springdoc where not needed

Summary by CodeRabbit

  • Dependency Updates
    • Removed SpringDoc OpenAPI UI dependencies from multiple integration projects
    • Added Jackson date/time type support in address integration client
    • Removed Maven release plugin configuration in gateway project

@simonhir simonhir self-assigned this Jan 13, 2025
@simonhir simonhir requested a review from a team as a code owner January 13, 2025 06:59
Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

Walkthrough

The pull request involves modifications to multiple pom.xml files across different projects. The changes primarily focus on removing specific dependencies related to SpringDoc OpenAPI UI and adjusting plugin configurations. In the refarch-gateway project, a Maven release plugin configuration is removed, while in various integration projects, dependencies for SpringDoc OpenAPI UI for both WebMVC and WebFlux are deleted. Additionally, a Jackson date-time type dependency is added to one of the integration client projects.

Changes

File Change Summary
refarch-gateway/pom.xml Removed maven-release-plugin configuration for automatic submodule versioning
refarch-integrations/.../refarch-address-integration-client/pom.xml Removed springdoc-openapi-starter-webmvc-ui dependency
Added jackson-datatype-jsr310 dependency
refarch-integrations/.../refarch-cosys-integration-client/pom.xml Removed springdoc-openapi-starter-webflux-ui dependency
refarch-integrations/.../refarch-dms-integration-fabasoft-rest-api/pom.xml Removed springdoc-openapi-starter-webflux-ui dependency

Suggested Labels

Component: API-Gateway, Type: Documentation

Suggested Reviewers

  • devtobi

Poem

🐰 Hop, hop, through Maven's grove,
Dependencies pruned with gentle love,
OpenAPI UI, now out of sight,
Configurations trimmed, clean and light!
A rabbit's dance of code delight! 🌟


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 365c358 and bb97f40.

📒 Files selected for processing (4)
  • refarch-gateway/pom.xml (0 hunks)
  • refarch-integrations/refarch-address-integration/refarch-address-integration-client/pom.xml (1 hunks)
  • refarch-integrations/refarch-cosys-integration/refarch-cosys-integration-client/pom.xml (0 hunks)
  • refarch-integrations/refarch-dms-integration/refarch-dms-integration-fabasoft-rest-api/pom.xml (0 hunks)
💤 Files with no reviewable changes (3)
  • refarch-integrations/refarch-cosys-integration/refarch-cosys-integration-client/pom.xml
  • refarch-integrations/refarch-dms-integration/refarch-dms-integration-fabasoft-rest-api/pom.xml
  • refarch-gateway/pom.xml
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build (refarch-gateway, true)
  • GitHub Check: build-maven
🔇 Additional comments (2)
refarch-integrations/refarch-address-integration/refarch-address-integration-client/pom.xml (2)

55-58: LGTM! Essential addition for proper date/time handling.

The addition of jackson-datatype-jsr310 is necessary and aligns well with the OpenAPI generator configuration that uses Java 8 date library. This dependency ensures proper serialization/deserialization of temporal types in the generated API client.


Line range hint 1-124: Verify the impact of removing springdoc-openapi-starter-webmvc-ui.

The removal of the springdoc dependency aligns with the PR objectives. However, let's verify that this removal doesn't affect any existing API documentation needs.

✅ Verification successful

Removal of springdoc-openapi-starter-webmvc-ui is safe

The removal of this dependency is appropriate as:

  • The client module is focused on API client generation, not API documentation hosting
  • The core module doesn't expose REST endpoints requiring documentation
  • Other modules' documentation needs are handled independently
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if there are any remaining references to springdoc or if other modules still depend on API documentation.

# Check for any remaining springdoc references
echo "Checking for remaining springdoc references..."
rg -l "springdoc|openapi.*ui" --type xml

# Check if any other modules reference this module and might expect the removed dependency
echo "Checking for modules that depend on this module..."
find . -name "pom.xml" -exec grep -l "refarch-address-integration-client" {} \;

Length of output: 806


Script:

#!/bin/bash
# Check if the core module has REST endpoints or API documentation needs
echo "Checking core module for REST endpoints..."
rg -l "@RestController|@RequestMapping" --type-add 'java:*.java' --type java ./refarch-integrations/refarch-address-integration/refarch-address-integration-core/

echo "Checking core module's pom.xml for springdoc..."
rg "springdoc" ./refarch-integrations/refarch-address-integration/refarch-address-integration-core/pom.xml

Length of output: 473


🪧 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

@github-actions github-actions bot added Component: API-Gateway Issues regarding the API Gateway Component: Integrations Issues regarding the Integrations Type: Maintenance The issue contains maintenance work. labels Jan 13, 2025
@simonhir simonhir merged commit ceb583a into main Jan 13, 2025
11 checks passed
@simonhir simonhir deleted the maint/cleanup-poms branch January 13, 2025 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: API-Gateway Issues regarding the API Gateway Component: Integrations Issues regarding the Integrations Type: Maintenance The issue contains maintenance work.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants