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

Update dependency org.springdoc:springdoc-openapi-starter-webmvc-ui to v2.8.4 #586

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 24, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
org.springdoc:springdoc-openapi-starter-webmvc-ui (source) 2.6.0 -> 2.8.4 age adoption passing confidence

Release Notes

springdoc/springdoc-openapi (org.springdoc:springdoc-openapi-starter-webmvc-ui)

v2.8.4

Compare Source

Added
  • #​2873 - Improve performance of getGenericMapResponse
  • #​2836 - Provide option to set allowed locales
  • 2862 - Align Swagger-UI Prefix Path with Swagger-WebMvc Behavior
Changed
  • Upgrade spring-boot to 3.4.2
  • Upgrade spring-cloud-function to 4.2.1
  • Upgrade swagger-core to 2.2.28
Fixed
  • #​2870 - Springdoc 2.8.x + Spring Boot 3.4.1 breaks native image support
  • #​2869 - Exception logged when generating schema for delete method of Spring Data repository.
  • #​2856 - @​JsonUnwrapped is ignored in new version of lib.
  • #​2852 - @​Schema(types = "xxx") does not work for multipart param with enabled springdoc.default-support-form-data config option.

v2.8.3

Compare Source

Added
  • #​2851 - Refine condition, for ignoring types when using PolymorphicModelConverter

v2.8.2

Compare Source

Added
  • #​2849 - Provide better compatibility for projects migrating from OAS 3.0 to OAS 3.1
Fixed
  • #​2846 - ClassCastException with spring-data-rest and openapi version 3.1 bug
  • #​2844 - PageableObject and SortObject are called Pageablenull and Sortnull

v2.8.1

Compare Source

Fixed
  • #​2834 - java.lang.ClassNotFoundException: kotlin.reflect.full.KClasses when upgrade from 2.7.0 to 2.8.0

v2.8.0

Compare Source

Added
  • #​2790 - Moving to OpenAPI 3.1 as the default implementation for springdoc-openapi
  • #​2817 - Obey annotations when flattening ParameterObject fields
  • #​2826 - Make it possible to mark parameters with @​RequestParam annotation to be sent in form instead of query.
  • #​2822 - Support returning null in ParameterCustomizer
  • #​2830 - Add support for deprecated fields.
  • #​2780 - Add Security Schema by AutoConfigure
Changed
  • Upgrade spring-boot to 3.4.1
  • Upgrade spring-cloud-function to 4.2.0
  • Upgrade swagger-core to 2.2.27
Fixed
  • #​2804 - Stable release 2.7.0 depends on Spring Cloud Milestone 4.2.0-M1
  • #​2828 - Required a bean of type 'org.springframework.data.rest.webmvc.mapping.Associations' that could not be found.
  • #​2823 - Capturing pattern in identical paths only renders the path element of one method
  • #​2817 - Automatically add required if a field is @​notNull or @​NotBlank.
  • #​2814 - An unresolvable circular reference with management.endpoint.gateway.enabled=true.
  • #​2798 - Object schema generated for Unit Kotlin type.
  • #​2797 - Removing operationId via customizer does not work anymore.
  • #​2833 - Resolve infinite recursion and add example test with OpenAPI v3.1
  • #​2827 - Ignoring @​Parameter(required = false)

v2.7.0

Added
  • #​2777 - Add SortAsQueryParam annotation
  • #​2786 - No static resource swagger-ui/index.html error after migration to 2.7.0-RC1
Changed
  • Upgrade spring-boot to 3.4.0
  • Upgrade swagger-ui to 5.18.2
  • Upgrade spring-security-oauth2-authorization-server to 1.4.0

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the renovate renovate related stuff label Nov 24, 2024
@renovate renovate bot force-pushed the renovate/org.springdoc.version branch 2 times, most recently from 3cae617 to 6f71605 Compare November 27, 2024 08:44
Copy link
Contributor

coderabbitai bot commented Nov 27, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request involves a consistent version update of the SpringDoc library across multiple microservices within the project. Specifically, the org.springdoc.version property in the pom.xml files of twelve different services has been upgraded from version 2.6.0 to 2.8.3. This change is uniform across all affected services, including wls-admin-service, wls-auth-service, wls-basisdaten-service, wls-briefwahl-service, wls-broadcast-service, wls-eai-service, wls-ergebnismeldung-service, wls-infomanagement-service, wls-monitoring-service, wls-vorfaelleundvorkommnisse-service, wls-wahlvorbereitung-service, and wls-wahlvorstand-service. The modification appears to be a library version update for OpenAPI documentation generation, with no other changes to the project structures or dependencies.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 or `` to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or `` 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.

@renovate renovate bot force-pushed the renovate/org.springdoc.version branch 4 times, most recently from dd39562 to 1be8db7 Compare December 2, 2024 08:00
@renovate renovate bot force-pushed the renovate/org.springdoc.version branch 10 times, most recently from 38cd318 to 809535e Compare December 11, 2024 09:12
@renovate renovate bot force-pushed the renovate/org.springdoc.version branch 3 times, most recently from c76b498 to 0600c9a Compare December 12, 2024 10:48
@renovate renovate bot changed the title Update dependency org.springdoc:springdoc-openapi-starter-webmvc-ui to v2.7.0 fix(deps): update dependency org.springdoc:springdoc-openapi-starter-webmvc-ui to v2.7.0 Dec 13, 2024
@renovate renovate bot force-pushed the renovate/org.springdoc.version branch from 0600c9a to 10ff4ec Compare December 13, 2024 11:00
@renovate renovate bot changed the title fix(deps): update dependency org.springdoc:springdoc-openapi-starter-webmvc-ui to v2.7.0 Update dependency org.springdoc:springdoc-openapi-starter-webmvc-ui to v2.7.0 Dec 16, 2024
@renovate renovate bot force-pushed the renovate/org.springdoc.version branch 6 times, most recently from a54023a to 59108b6 Compare December 18, 2024 08:06
@renovate renovate bot force-pushed the renovate/org.springdoc.version branch from 64a856b to a383aab Compare January 16, 2025 07:53
@renovate renovate bot force-pushed the renovate/org.springdoc.version branch 5 times, most recently from 75d8622 to 1275041 Compare January 22, 2025 08:27
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
wls-infomanagement-service/pom.xml (1)

38-38: Consider coordinating the Spring Boot upgrade across all services.

Since this is a microservices architecture with multiple services sharing common dependencies, I recommend:

  1. First, create a separate PR to upgrade Spring Boot to version 3.4.0 across all services
  2. Then, proceed with this PR to upgrade springdoc-openapi-starter-webmvc-ui to version 2.8.3

This approach helps maintain consistency and prevents potential compatibility issues.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 368c6da and 1275041.

📒 Files selected for processing (12)
  • wls-admin-service/pom.xml (1 hunks)
  • wls-auth-service/pom.xml (1 hunks)
  • wls-basisdaten-service/pom.xml (1 hunks)
  • wls-briefwahl-service/pom.xml (1 hunks)
  • wls-broadcast-service/pom.xml (1 hunks)
  • wls-eai-service/pom.xml (1 hunks)
  • wls-ergebnismeldung-service/pom.xml (1 hunks)
  • wls-infomanagement-service/pom.xml (1 hunks)
  • wls-monitoring-service/pom.xml (1 hunks)
  • wls-vorfaelleundvorkommnisse-service/pom.xml (1 hunks)
  • wls-wahlvorbereitung-service/pom.xml (1 hunks)
  • wls-wahlvorstand-service/pom.xml (1 hunks)
🔇 Additional comments (10)
wls-eai-service/pom.xml (1)

37-37: Version incompatibility with Spring Boot.

The springdoc-openapi-starter-webmvc-ui 2.8.3 requires Spring Boot 3.4.0, but this service is using Spring Boot 3.3.5.

wls-briefwahl-service/pom.xml (1)

38-38: Version incompatibility with Spring Boot.

The springdoc-openapi-starter-webmvc-ui 2.8.3 requires Spring Boot 3.4.0, but this service is using Spring Boot 3.3.5.

wls-wahlvorbereitung-service/pom.xml (1)

38-38: Version incompatibility with Spring Boot.

The springdoc-openapi-starter-webmvc-ui 2.8.3 requires Spring Boot 3.4.0, but this service is using Spring Boot 3.3.5.

wls-infomanagement-service/pom.xml (1)

38-38: Version incompatibility with Spring Boot.

The springdoc-openapi-starter-webmvc-ui 2.8.3 requires Spring Boot 3.4.0, but this service is using Spring Boot 3.3.5.

Let's verify if there are any other services that need the Spring Boot version update:

#!/bin/bash
# Description: Find all pom.xml files and check their Spring Boot and springdoc versions

echo "Checking Spring Boot and springdoc versions in all services..."
find . -name "pom.xml" -type f -exec sh -c '
    echo "\nChecking {}:"
    grep -A1 "<spring.boot.version>" {} | head -n 2
    grep -A1 "<org.springdoc.version>" {} | head -n 2
' \;
wls-vorfaelleundvorkommnisse-service/pom.xml (1)

38-38: Skipping review of duplicate changes.

The changes in this file are identical to those in wls-broadcast-service/pom.xml and the same compatibility concerns apply.

wls-monitoring-service/pom.xml (1)

38-38: Skipping review of duplicate changes.

The changes in this file are identical to those in wls-broadcast-service/pom.xml and the same compatibility concerns apply.

wls-ergebnismeldung-service/pom.xml (1)

40-40: Skipping review of duplicate changes.

The changes in this file are identical to those in wls-broadcast-service/pom.xml and the same compatibility concerns apply.

wls-basisdaten-service/pom.xml (1)

38-38: Skipping review of duplicate changes.

The changes in this file are identical to those in wls-broadcast-service/pom.xml and the same compatibility concerns apply.

wls-wahlvorstand-service/pom.xml (1)

38-38: ⚠️ Potential issue

Verify Spring Boot compatibility before upgrading springdoc-openapi.

The springdoc-openapi v2.8.3 requires Spring Boot 3.4.0, but the project is using Spring Boot 3.3.5. This version mismatch could lead to compatibility issues.

Consider either:

  1. Upgrading Spring Boot to 3.4.0 first
  2. Using an older version of springdoc-openapi that's compatible with Spring Boot 3.3.5

Run this script to check the compatibility matrix:

wls-auth-service/pom.xml (1)

38-38: Maintain consistent Spring Boot compatibility across services.

The same compatibility issue exists in the auth service. The springdoc-openapi v2.8.3 requires Spring Boot 3.4.0, but the project is using Spring Boot 3.3.5.

@@ -36,7 +36,7 @@
<!-- Version muss mit der in den spring-boot-dependencies bereitgestellten Lombok-Version übereinstimmen -->
<org.projectlombok.lombok.version>1.18.30</org.projectlombok.lombok.version>
<org.projectlombok.mapstructbinding.version>0.2.0</org.projectlombok.mapstructbinding.version>
<org.springdoc.version>2.6.0</org.springdoc.version>
<org.springdoc.version>2.8.3</org.springdoc.version>
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Version incompatibility with Spring Boot.

The springdoc-openapi-starter-webmvc-ui 2.8.3 requires Spring Boot 3.4.0, but this service is using Spring Boot 3.3.5. Please update the Spring Boot version to 3.4.0 to ensure compatibility.

Apply this diff to update the Spring Boot version:

-        <spring.boot.version>3.3.5</spring.boot.version>
+        <spring.boot.version>3.4.0</spring.boot.version>

Committable suggestion skipped: line range outside the PR's diff.

@@ -35,7 +35,7 @@
<org.projectlombok.lombok.version>1.18.30</org.projectlombok.lombok.version>
<org.projectlombok.mapstructbinding.version>0.2.0</org.projectlombok.mapstructbinding.version>
<org.mapstruct.version>1.6.3</org.mapstruct.version>
<org.springdoc.version>2.6.0</org.springdoc.version>
<org.springdoc.version>2.8.3</org.springdoc.version>
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Spring Boot version upgrade required for springdoc-openapi compatibility

The version incompatibility is confirmed. The project uses Spring Boot 3.3.5, but springdoc-openapi v2.8.3 requires Spring Boot ≥3.4.0 (currently using 3.4.1 in its parent POM). Please upgrade the Spring Boot version to at least 3.4.0 to ensure compatibility.

🔗 Analysis chain

Verify Spring Boot version compatibility.

The current Spring Boot version (3.3.5) is lower than the required version (3.4.0) for springdoc-openapi-starter-webmvc-ui v2.8.3. This version mismatch might lead to compatibility issues.

Run the following script to check the compatibility matrix and available versions:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check springdoc and Spring Boot version compatibility

# Check springdoc releases for compatibility information
echo "Checking springdoc releases..."
curl -s "https://api.github.com/repos/springdoc/springdoc-openapi/releases/tags/v2.8.3" | jq -r '.body'

# Check if Spring Boot 3.4.0 is released
echo -e "\nChecking Spring Boot releases..."
curl -s "https://repo1.maven.org/maven2/org/springframework/boot/spring-boot/maven-metadata.xml" | grep -A 1 "<versions>"

Length of output: 618


Script:

#!/bin/bash
# Description: Check springdoc dependencies and Spring Boot versions

# Check springdoc pom.xml for Spring Boot version requirement
echo "Checking springdoc pom.xml..."
curl -s "https://raw.githubusercontent.com/springdoc/springdoc-openapi/v2.8.3/pom.xml" | grep -A 2 "<spring.boot.version>"

# Get recent Spring Boot versions (last 10)
echo -e "\nRecent Spring Boot versions:"
curl -s "https://repo1.maven.org/maven2/org/springframework/boot/spring-boot/maven-metadata.xml" | grep "<version>" | tail -n 10

Length of output: 703


Script:

#!/bin/bash
# Description: Check springdoc Spring Boot dependency with broader search

echo "Checking springdoc pom.xml for Spring Boot dependencies..."
curl -s "https://raw.githubusercontent.com/springdoc/springdoc-openapi/v2.8.3/pom.xml" | grep -B 2 -A 2 "spring-boot"

Length of output: 547

@renovate renovate bot force-pushed the renovate/org.springdoc.version branch 10 times, most recently from 12c7120 to bbbfb97 Compare January 26, 2025 22:45
@renovate renovate bot changed the title Update dependency org.springdoc:springdoc-openapi-starter-webmvc-ui to v2.8.3 Update dependency org.springdoc:springdoc-openapi-starter-webmvc-ui to v2.8.4 Jan 26, 2025
@renovate renovate bot force-pushed the renovate/org.springdoc.version branch 9 times, most recently from 1aaff3a to 23fe536 Compare January 29, 2025 10:40
@renovate renovate bot force-pushed the renovate/org.springdoc.version branch from 23fe536 to e764a8a Compare January 30, 2025 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
renovate renovate related stuff
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant