Documentation and Spring Boot 4 updates and fixes#3688
Open
jkaving wants to merge 4 commits intospring-projects:4.0.xfrom
Open
Documentation and Spring Boot 4 updates and fixes#3688jkaving wants to merge 4 commits intospring-projects:4.0.xfrom
jkaving wants to merge 4 commits intospring-projects:4.0.xfrom
Conversation
Spring uses Antora for documentation (see https://spring.io/blog/2023/05/11/spring-framework-reference-documentation-update) This means: - The single-page version of the documentation is no longer available - The documentation has a version drop-down, so we should no longer link to a specific version Signed-off-by: Johan Kaving <johan@kaving.se>
See https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-4.0-Migration-Guide#spring-session Signed-off-by: Johan Kaving <johan@kaving.se>
See https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-4.0-Migration-Guide#module-dependencies This updates both the sample applications and the dependency examples in the documentation. Signed-off-by: Johan Kaving <johan@kaving.se>
In spring-session.sample-boot-jdbc we set spring.datasource.generate-unique-name=false so the documentation's reference to "jdbc:h2:mem:testdb" is correct (see spring-session-docs/modules/ROOT/pages/guides/boot-jdbc.adoc). Spring Boot sets this property to "true" by default, which results in the embedded H2 database getting a random name (instead of "testdb"). Signed-off-by: Johan Kaving <johan@kaving.se>
jkaving
force-pushed
the
spring-boot-4-documentation
branch
from
d8460b2 to
539795c
Compare
spring-projects-issues
added
the
status: waiting-for-triage
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Fixes
Spring now uses Antora for documentation, which means:
(This means we no longer need to parse versions, so it was possible to make a bit of cleanup in
spring-session-docs.gradle).There are currently a number of broken links because of this, and I've tried to fix all of them.
Property Changes in Spring Boot
The Spring Session Data Redis properties have been renamed in Spring Boot 4. See here in the migration documentation.
This updates the documentation to use these new property names.
Spring Boot Modular Design
I've updated the samples and the documentation to use the starters now recommended by Spring Boot 4 (see here).
Bonus fix
While testing my changes I had problems when running the
spring-session-sample-boot-jdbcand trying to connect with the H2 console using the JDBC URL specified in the documentation.That's because Spring Boot will give the database a unique (random) name by default.
I've added a property to avoid that and make the
jdbc:h2:mem:testdbURL work.Note: I've tried to follow the contributing guidelines and based this on the oldest impacted maintenance branch, which I think is 4.0.x.