Skip to content

Update Dropwizard 5.0.0 documentation for dependency upgrades and Java 17 requirement#10415

Merged
joschi merged 4 commits intorelease/5.0.xfrom
copilot/fix-11e9b422-1eae-484d-a9c8-b3c728a1c208
Aug 25, 2025
Merged

Update Dropwizard 5.0.0 documentation for dependency upgrades and Java 17 requirement#10415
joschi merged 4 commits intorelease/5.0.xfrom
copilot/fix-11e9b422-1eae-484d-a9c8-b3c728a1c208

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 25, 2025

This PR updates the Dropwizard documentation to reflect the major changes in version 5.0.0, including significant dependency upgrades and the new Java 17 baseline requirement.

Key Changes

Release Notes & Version Documentation

  • Added comprehensive v5.0.0 release notes with all major dependency upgrades
  • Updated documentation version index to include 5.0.x and other missing recent versions
  • Documented the Java 17+ requirement prominently

Dependency Upgrade Documentation

Added detailed documentation for major dependency upgrades in the 5.0.x upgrade notes:

Library 4.0.x Version 5.0.x Version
Jackson 2.15.x 2.19.x
Jersey 3.0.x 3.1.x
Jetty 11.x 12.1.x
Hibernate 6.1.x 6.6.x
Hibernate Validator 7.x 8.0.x
Liquibase 4.20.x 4.33.x
JUnit 5.9.x 5.13.x

Java Version Updates

  • Updated all Java version references from 11 to 17 throughout the documentation
  • Added a Prerequisites section to the Getting Started guide emphasizing Java 17+ requirement
  • Updated example POMs to use Java 17 as the compilation target
  • Removed outdated Java 8 compatibility notes that no longer apply

Example Code Maintenance

  • Updated Maven plugin versions in documentation examples to more current releases
  • Fixed example JAR version references to use 5.0.0-SNAPSHOT
  • Updated build tool requirements and instructions

Migration Guidance

Enhanced the upgrade notes with specific migration guidance for:

  • Jackson 2.19.x: Performance improvements and Java 17+ optimizations
  • JUnit 5.13.x: Enhanced parallel execution and Jupiter API features
  • Hibernate 6.6.x: Continued type system improvements and Jakarta Persistence 3.1 support
  • Liquibase 4.33.x: Enhanced change log parsing and database compatibility

Technical Details

All changes maintain backward compatibility in terms of documentation structure and do not introduce any breaking changes to the build process. The documentation builds successfully with Sphinx 7.4.7 and all internal references are properly maintained.

These updates ensure that developers upgrading to Dropwizard 5.0.0 have comprehensive information about:

  • Required environment changes (Java 17+)
  • Major dependency upgrades and their implications
  • Migration paths for applications using affected dependencies
  • Updated example code and build configurations

Verification

  • ✅ Documentation builds without errors
  • ✅ All version references updated consistently
  • ✅ No conflicting version information
  • ✅ Examples use current Maven plugin versions
  • ✅ Prerequisites clearly documented

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Dropwizard 5.0.0 has seen many dependency upgrades. The goal is to verify that the documentation in the release/5.0.x branch in the docs/source directory is up-to-date and suggest changes to make the documentation up-to-date. Make a plan which th... Update Dropwizard 5.0.0 documentation for dependency upgrades and Java 17 requirement Aug 25, 2025
Copilot AI requested a review from joschi August 25, 2025 23:01
@github-actions github-actions bot added this to the 5.0.0 milestone Aug 25, 2025
@joschi joschi marked this pull request as ready for review August 25, 2025 23:06
@joschi joschi requested a review from a team as a code owner August 25, 2025 23:06
@joschi joschi enabled auto-merge (squash) August 25, 2025 23:07
@joschi joschi force-pushed the copilot/fix-11e9b422-1eae-484d-a9c8-b3c728a1c208 branch from 9517888 to f3c52e5 Compare August 25, 2025 23:07
@joschi joschi disabled auto-merge August 25, 2025 23:10
@joschi joschi merged commit d68d43a into release/5.0.x Aug 25, 2025
9 of 10 checks passed
@joschi joschi deleted the copilot/fix-11e9b422-1eae-484d-a9c8-b3c728a1c208 branch August 25, 2025 23:10
@sonarqubecloud
Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants