Skip to content

Commit

Permalink
doc: links to session module (micronaut-projects#8788)
Browse files Browse the repository at this point in the history
* Link to breaking changes

* add dependencies macros for retry & discovery-core

* fix link

* Update src/main/docs/guide/appendix/breaks.adoc
  • Loading branch information
sdelamo authored Feb 17, 2023
1 parent 4233157 commit 13ba563
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
20 changes: 15 additions & 5 deletions src/main/docs/guide/appendix/breaks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,22 @@ This section documents breaking changes between Micronaut versions

The `micronaut-runtime` module has been split into separate modules depending on the application's use case:

* `micronaut-retry` - The retry implementation including annotations such as ann:retry.annotation.Retryable[] is now a separate module that can be optionally included in a Micronaut application.
* `micronaut-discovery-core` - The base service discovery features are now a separate module. If you application listens for events such as api:discovery.event.ServiceReadyEvent[] or api:discovery.heartbeat.HeartBeatEvent[] this module should be added to the application classpath.
===== Micronaut Discovery Core

`micronaut-discovery-core` - The base service discovery features are now a separate module. If you application listens for events such as api:discovery.event.ServiceReadyEvent[] or api:health.HeartBeatEvent[] this module should be added to the application classpath.

dependency::micronaut-discovery[]

===== Micronaut Retry

`micronaut-retry` - The retry implementation including annotations such as ann:retry.annotation.Retryable[] is now a separate module that can be optionally included in a Micronaut application.

In addition, since `micronaut-retry` is now optional declarative clients annotated with ann:http.client.annotation.Client[] no longer invoke fallbacks by default. To restore the previous behaviour add `micronaut-retry` to your classpath and annotate any declarative clients with ann:retry.annotation.Recoverable[].

To use the Retry functionality, add the following dependency:

dependency::micronaut-retry[]

==== Calling `registerSingleton(bean)` no longer overrides existing beans

If you call `registerSingleton(bean)` on the api:context.BeanContext[] this will no longer override existing beans if the type and qualifier match, instead two beans will now exist which may lead to a api:context.exceptions.NonUniqueBeanException[].
Expand All @@ -32,7 +43,7 @@ context.registerBeanDefinition(

==== WebSocket No Longer Required

The `micronaut-websocket` API is no longer a required dependency of the HTTP server. If you are using annotations such as ann:websocket.annotation.ServerWebSocket[] you should add the `micronaut-websocket` dependency to your application classpath:
`io.micronaut:micronaut-http-server` no longer exposes `micronaut-websocket` transitively. If you are using annotations such as ann:websocket.annotation.ServerWebSocket[], you should add the `micronaut-websocket` dependency to your application classpath:

dependency::micronaut-websocket[]

Expand All @@ -44,8 +55,7 @@ dependency:micronaut-reactor[groupId="io.micronaut.reactor"]

==== Session Support Moved to Session Module

The Session handling features have been moved to a new `micronaut-session` module.
If you require session support, you should make your application depend on
The Session handling features https://micronaut-projects.github.io/micronaut-session/snapshot/guide/[have been moved to its own module]. If you use the HTTP session module, change the maven coordinates from `io.micronaut:micronaut-session` to `io.micronaut.session:micronaut-session`.

dependency:micronaut-session[groupId="io.micronaut.session"]

Expand Down
2 changes: 2 additions & 0 deletions src/main/docs/guide/introduction/whatsNew.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ When a bean annotated with ann:context.annotation.EachProperty[] or ann:context.

- Kotlin 1.7.10

<<breaks, Breaking changes in Micronaut Framework 4.0>>

== 3.8.0

Key features:
Expand Down

0 comments on commit 13ba563

Please sign in to comment.