-
Notifications
You must be signed in to change notification settings - Fork 101
Improve "Add explicit Common Annotations dependencies" in "Migrate to Java 11" #816
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
Conversation
groupId: jakarta.annotation | ||
artifactId: jakarta.annotation-api | ||
newVersion: 2.1.x | ||
- org.openrewrite.java.ChangeType: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ℹ️ The UpdateJakartaAnnotations2
recipe should not contain these ChangeType changes, as the JavaxAnnotationMigrationToJakartaAnnotation
recipe, located in jakarta-ee-9.xml, does already do these migrations:
Because jakarta-ee-10 calls jakarta-ee-9, the namespace fix will already be applied.
The reason these ChangeType recipes were added here, was because there was a bug in the JavaxAnnotationMigrationToJakartaAnnotation
recipe, what let to an unchanged javax namespace. That bug has been fixed, so we don't need there recipe here anymore.
Noting it here in case it pops up: there's small chance some of these recipes might have been customized, and those customizations would then refer to a recipe that no longer exists; that's benign when running a recipe, but could fail validation in tests. The solution then is to either update or remove those references in customized recipes. |
…12.0 to 3.15.0 [skip ci] Bumps [org.openrewrite.recipe:rewrite-migrate-java](https://github.com/openrewrite/rewrite-migrate-java) from 3.12.0 to 3.15.0. Release notes *Sourced from [org.openrewrite.recipe:rewrite-migrate-java's releases](https://github.com/openrewrite/rewrite-migrate-java/releases).* > 3.15.0 > ------ > > What's Changed > -------------- > > * Convert assigning Switch statements to Switch expressions by [`@pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-migrate-java#795](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/795) > * Convert switch expressions to arrows where possible by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#801](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/801) > * Convert switch cases with returns to returned switch expression by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#802](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/802) > * `ReplaceStreamCollectWithToList` should look at return type by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#803](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/803) > * New recipe to adopt Lombok setter method names by [`@timo-a`](https://github.com/timo-a) in [openrewrite/rewrite-migrate-java#632](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/632) > * refactor: Static imports for Collections and Collectors by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#804](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/804) > * Preserve whitespace in `MigrateCollectionsUnmodifiableList` by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#806](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/806) > * rename settings.local.json to settings.json by [`@zieka`](https://github.com/zieka) in [openrewrite/rewrite-migrate-java#808](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/808) > * The quick fix for the tests for Jaxws Dependencies by [`@steve-aom-elliott`](https://github.com/steve-aom-elliott) in [openrewrite/rewrite-migrate-java#809](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/809) > * Refactor RewriteTest to use defaults method by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#814](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/814) > * Create `is` methods for boolean fields in `LombokValueToRecord` by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#813](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/813) > * Joda-time: Make safe migration optional by [`@amishra-u`](https://github.com/amishra-u) in [openrewrite/rewrite-migrate-java#811](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/811) > * Improve "Add explicit Common Annotations dependencies" in "Migrate to Java 11" by [`@jevanlingen`](https://github.com/jevanlingen) in [openrewrite/rewrite-migrate-java#816](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/816) > * chore(ci): bump actions/checkout from 4 to 5 by [`@dependabot`](https://github.com/dependabot)[bot] in [openrewrite/rewrite-migrate-java#817](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/817) > > **Full Changelog**: <openrewrite/rewrite-migrate-java@v3.14.0...v3.15.0> > > 3.14.1 > ------ > > What's Changed > -------------- > > * OpenRewrite v8.59.1: <https://github.com/openrewrite/rewrite> > > **Full Changelog**: <https://github.com/openrewrite/rewrite-migrate-java> > > 3.14.0 > ------ > > What's Changed > -------------- > > * `NullCheckAsSwitchCase` should only add `null` case if the switch is exhaustive by [`@Jenson3210`](https://github.com/Jenson3210) in [openrewrite/rewrite-migrate-java#769](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/769) > * Let all change-to-var recipes use a created var-Identifier instead of using a JavaTemplate by [`@jevanlingen`](https://github.com/jevanlingen) in [openrewrite/rewrite-migrate-java#793](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/793) > * Fix NPE in IteratorNext recipe when iterator() has no explicit receiver by [`@jkschneider`](https://github.com/jkschneider) in [openrewrite/rewrite-migrate-java#796](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/796) > * `LombokValueToRecord` should rewrite method references too by [`@holgpar`](https://github.com/holgpar) in [openrewrite/rewrite-migrate-java#469](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/469) > * Update test expectations to now finish idempotent `ChangeTagAttribute` in a single cycle by [`@pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-migrate-java#797](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/797) > * refactor: Unwrap else block after return or throw statement by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#798](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/798) > > **Full Changelog**: <openrewrite/rewrite-migrate-java@v3.13.0...v3.14.0> > > 3.13.0 > ------ > > What's Changed > -------------- > > * refactor: org.openrewrite.mavencentral by [`@Laurens-W`](https://github.com/Laurens-W) in [openrewrite/rewrite-migrate-java#778](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/778) > * Do not add explicit `Record` class import if using `var` keyword by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#781](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/781) > * Correct groupId for `jakarta.annotation:jakarta.annotation-api` upgrade by [`@steve-aom-elliott`](https://github.com/steve-aom-elliott) in [openrewrite/rewrite-migrate-java#784](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/784) > * Keep `jakarta.annotation-api` dependency when moving to Jakarta with Spring Boot project and Jakarta annotations are used by [`@jevanlingen`](https://github.com/jevanlingen) in [openrewrite/rewrite-migrate-java#782](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/782) > * Add Bouncy Castle upgrade recipe for Java < 8 by [`@pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-migrate-java#790](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/790) > * Fix `LombokValToFinalVar` in loops by [`@MBoegers`](https://github.com/MBoegers) in [openrewrite/rewrite-migrate-java#768](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/768) > * Replace JavaTemplate by a `var` identifier element for UseVarForGenericsConstructors recipe by [`@jevanlingen`](https://github.com/jevanlingen) in [openrewrite/rewrite-migrate-java#789](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/789) > * Add missing type table entries by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#792](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/792) > * Migrate Lombok's `@__` syntax to `onX_` for Java 8+ by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-migrate-java#794](https://redirect.github.com/openrewrite/rewrite-migrate-java/pull/794) ... (truncated) Commits * [`f65c067`](openrewrite/rewrite-migrate-java@f65c067) Restore `UpdateJakartaAnnotations2` as a deprecated placeholder * [`aa973e9`](openrewrite/rewrite-migrate-java@aa973e9) chore(ci): bump actions/checkout from 4 to 5 ([#817](https://redirect.github.com/openrewrite/rewrite-migrate-java/issues/817)) * [`a6a509e`](openrewrite/rewrite-migrate-java@a6a509e) Improve "Add explicit Common Annotations dependencies" in "Migrate to Java 11... * [`cbe5ca5`](openrewrite/rewrite-migrate-java@cbe5ca5) [Auto] SDKMAN! Java candidates as of 2025-08-11T1018 * [`180b215`](openrewrite/rewrite-migrate-java@180b215) Revert "Joda-time: Make safe migration optional ([#811](https://redirect.github.com/openrewrite/rewrite-migrate-java/issues/811))" * [`531270b`](openrewrite/rewrite-migrate-java@531270b) Joda-time: Make safe migration optional ([#811](https://redirect.github.com/openrewrite/rewrite-migrate-java/issues/811)) * [`9f029e3`](openrewrite/rewrite-migrate-java@9f029e3) Create `is` methods for boolean fields in `LombokValueToRecord` ([#813](https://redirect.github.com/openrewrite/rewrite-migrate-java/issues/813)) * [`bc6f9dc`](openrewrite/rewrite-migrate-java@bc6f9dc) Allow BouncyCastleTest to match in any order * [`eef26e4`](openrewrite/rewrite-migrate-java@eef26e4) Refactor RewriteTest to use defaults method ([#814](https://redirect.github.com/openrewrite/rewrite-migrate-java/issues/814)) * [`d9674d1`](openrewrite/rewrite-migrate-java@d9674d1) Delegate from `RemoveIllegalSemicolons` to `RemoveExtraSemicolons` * Additional commits viewable in [compare view](openrewrite/rewrite-migrate-java@v3.12.0...v3.15.0) [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- Dependabot commands and options You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
What's changed?
The counteract recipe now works as intended. When migrating to Java 17, it will update any added or updated dependency on
jakarta.annotation:jakarta.annotation-api:1.3.5
to version 2.0.What's your motivation?
The original PR
introduced the AddCommonAnnotationsDependencies recipe. While useful, it made the migration chains harder to reason about. In rewrite-migrate-java, there are two major migration chains:
The AddCommonAnnotationsDependencies recipe started to conceptually mingle the two chains. As migrating to Java 11 requires some dependency to support the javax namespace, it needs to be there. However, if you want to migrate to newer versions than Java 11, the Java chain never actually updated the Javax namespace to the Jakarta namespace (the counteract recipe was originally part of the EE chain only).
In some cases, this could even lead to errors such as:
By adding the counteract recipe to the Java chain, we prevent these issues. It’s worth noting that the original counteract recipe wasn’t truly a “counter” recipe. It was more of a best-practice recipe; it's limited to the Jakarta EE chain and only worked for Spring Boot migrations.
Checklist