From ac4a792f84110bd95468305a5257a5a61e52b23e Mon Sep 17 00:00:00 2001 From: Steve Ebersole Date: Tue, 8 Mar 2022 11:26:55 -0600 Subject: [PATCH] render migration guide using asciidoctor and publish with docs --- documentation/documentation.gradle | 28 ++++++++++++++++++++++++++++ migration-guide.adoc | 10 +++------- 2 files changed, 31 insertions(+), 7 deletions(-) diff --git a/documentation/documentation.gradle b/documentation/documentation.gradle index 4ceecd178d..8a227bc642 100644 --- a/documentation/documentation.gradle +++ b/documentation/documentation.gradle @@ -192,6 +192,34 @@ task renderIntegrationGuide(type: AsciidoctorTask, group: 'Documentation') {task } } + +// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +// Migration Guide + +task renderMigrationGuide(type: AsciidoctorTask, group: 'Documentation') {task-> + description = 'Renders the Migration Guide in HTML format using Asciidoctor.' + tasks.buildDocsForPublishing.dependsOn task + + sourceDir = rootProject.layout.projectDirectory + sources { + include 'migration-guide.adoc' + } + + outputDir = project.layout.buildDirectory.dir( 'asciidoc/migration-guide' ) + + attributes linkcss: true, + stylesheet: "css/hibernate.css" + + resources { + from('src/main/style/asciidoctor') { + include 'images/**' + } + from('src/main/style/asciidoctor') { + include 'css/**' + } + } +} + tasks.withType(AsciidoctorTask).all { baseDirFollowsSourceDir() outputOptions { diff --git a/migration-guide.adoc b/migration-guide.adoc index 519962533a..d7f88debe4 100644 --- a/migration-guide.adoc +++ b/migration-guide.adoc @@ -7,11 +7,12 @@ :fn-converter: footnote:converter[Think `AttributeConverter`] - - This guide discusses migration from Hibernate ORM version 6.0. For migration from earlier versions, see any other pertinent migration guides as well. +== Java 11 + +With 6.0, Hibernate ORM has moved to expect Java 11 as its baseline version. == Jakarta Persistence @@ -35,11 +36,6 @@ in migration. It logs a deprecation warning when the Java EE variants are used. directory in the project root for the configuration used to migrate Hibernate itself. -== Java 11 - -With 6.0, Hibernate ORM has moved to expect Java 11 as its baseline version - - [[read-jdbc]] == Reading from JDBC