-
Notifications
You must be signed in to change notification settings - Fork 90
Spring Boot 3 Upgrade Report Contribution Guideline
This document describes the process of creating a report and automated migration for upgrading a Spring Boot 2.7 application to 3.0. It is meant to be used as a reference to contributing a detailed section in the upgrade report and an automated migration recipe to mitigate a change, where possible.
Spring Boot Migrator aims to provide a report for Spring Boot 2.7 applications describing all required changes to upgrade a scanned application to 3.0.
Every change is described in a separate section of the report. When a migration recipe exists that can automatically mitigate the change in the scanned application it should be executable from within the report.
The report sections should provide guidance and additional information of why this change is applicable to a scanned application and what needs to be done to mitigate the change.
A report section is a single section in the Upgrade Report. This section describes a single change that was introduced with Spring Boot 3.0. Providing detailed information about every change and how to mitigate it is a natural first step before attempting to provide an automated recipe.
Every report section is provided in YAML syntax in the sbu30-report.yaml file.
This section describes how to provide a migration recipe to automatically mitigate a change described in the Upgrade Report. Not every change can be automatically migrated. There are cases where a user decision is required or a migration is too complex to justify the effort of providing an automated recipe. But some can certainly be automated.
Spring Boot Migrator uses Open Rewrite to a large extent and we