hibernate-orm/documentation/documentation.gradle

904 lines
28 KiB
Groovy
Raw Normal View History

import java.util.function.Function
import org.asciidoctor.gradle.jvm.AsciidoctorTask
2023-05-11 10:54:58 -04:00
import org.asciidoctor.gradle.jvm.pdf.AsciidoctorPdfTask
buildscript {
configurations.all {
resolutionStrategy.dependencySubstitution {
substitute module( 'com.burgstaller:okhttp-digest:1.10' ) using module(
'io.github.rburgst:okhttp-digest:1.21'
) because 'okhttp-digest only version 1.21 is available on Maven Central. Old version was on jcenter, which asciidoctor-gradle-plugin depends on transitively through simplified-jruby-gradle-plugin via http-builder-ng-okhttp '
}
}
}
plugins {
2024-07-15 13:27:12 -04:00
id 'org.asciidoctor.jvm.convert' version '4.0.2'
id 'org.asciidoctor.jvm.pdf' version '4.0.2'
id "org.asciidoctor.jvm.gems" version "4.0.2"
id "org.hibernate.orm.build.settings-doc"
}
repositories {
mavenCentral()
ruby.gems()
}
2017-12-13 10:15:22 -05:00
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
apply from: rootProject.file( 'gradle/module.gradle' )
apply from: rootProject.file( 'gradle/releasable.gradle' )
2022-03-09 13:28:13 -05:00
apply plugin: 'org.hibernate.orm.build.reports'
2013-11-22 15:51:56 -05:00
defaultTasks 'buildDocs'
configurations {
core
testing
envers
spatial
agroal
c3p0
hikaricp
proxool
vibur
jcache
jpamodelgen
javadocClasspath {
description = 'Class files for the javadoc to be built'
resolutionStrategy.capabilitiesResolution.withCapability('org.junit.jupiter:junit-jupiter-params:5.7.1') { details ->
details.select( details.candidates.first() ).because( 'first' )
}
extendsFrom core
extendsFrom testing
extendsFrom envers
extendsFrom spatial
extendsFrom agroal
extendsFrom c3p0
extendsFrom hikaricp
extendsFrom proxool
extendsFrom vibur
extendsFrom jcache
extendsFrom jpamodelgen
}
javadocSources {
description = 'Source files to be built by the javadoc tool'
}
}
dependencies {
attributesSchema { schema ->
schema.attribute(Bundling.BUNDLING_ATTRIBUTE) { matchStrategy ->
final def nameComparator = Comparator.comparing(
new Function<Bundling,String>() {
@Override
String apply(Bundling o) {
return o.name
}
}
)
matchStrategy.ordered(new Comparator<Bundling>() {
@Override
int compare(Bundling o1, Bundling o2) {
if ( Objects.equals( o1, o2 ) ) {
return 0;
}
if ( o1 == null ) {
return 1;
}
if ( o2 == null ) {
return -1;
}
if ( o1.name == Bundling.EMBEDDED ) {
return -1;
}
if ( o2.name == Bundling.EMBEDDED ) {
return 1;
}
return nameComparator.compare(o1,o2)
}
} )
}
}
ext.pressgangVersion = '3.0.0'
2013-11-22 15:51:56 -05:00
2022-03-09 13:28:13 -05:00
reportAggregation project( ':hibernate-agroal' )
reportAggregation project( ':hibernate-c3p0' )
reportAggregation project( ':hibernate-core' )
reportAggregation project(':hibernate-envers')
reportAggregation project(':hibernate-graalvm')
reportAggregation project(':hibernate-hikaricp')
reportAggregation project(':hibernate-jcache')
reportAggregation project(':hibernate-micrometer')
reportAggregation project(':hibernate-proxool')
reportAggregation project(':hibernate-spatial')
reportAggregation project(':hibernate-vibur')
reportAggregation project(':hibernate-ant')
reportAggregation project(':hibernate-enhance-maven-plugin')
reportAggregation project(':hibernate-jpamodelgen')
asciidoctorGems 'rubygems:rouge:4.1.1'
core project( ':hibernate-core' )
javadocSources project( path: ':hibernate-core', configuration: 'javadocSources' )
testing project( ':hibernate-testing' )
javadocSources project( path: ':hibernate-testing', configuration: 'javadocSources' )
envers project( ':hibernate-envers' )
javadocSources project( path: ':hibernate-envers', configuration: 'javadocSources' )
spatial project( ':hibernate-spatial' )
javadocSources project( path: ':hibernate-spatial', configuration: 'javadocSources' )
agroal project( ':hibernate-agroal' )
javadocSources project( path: ':hibernate-agroal', configuration: 'javadocSources' )
c3p0 project( ':hibernate-c3p0' )
javadocSources project( path: ':hibernate-c3p0', configuration: 'javadocSources' )
hikaricp project( ':hibernate-hikaricp' )
javadocSources project( path: ':hibernate-hikaricp', configuration: 'javadocSources' )
proxool project( ':hibernate-proxool' )
javadocSources project( path: ':hibernate-proxool', configuration: 'javadocSources' )
vibur project( ':hibernate-vibur' )
javadocSources project( path: ':hibernate-vibur', configuration: 'javadocSources' )
jcache project( ':hibernate-jcache' )
javadocSources project( path: ':hibernate-jcache', configuration: 'javadocSources' )
jpamodelgen project( ':hibernate-jpamodelgen' )
javadocSources project( path: ':hibernate-jpamodelgen', configuration: 'javadocSources' )
javadocClasspath libs.loggingAnnotations
javadocClasspath jakartaLibs.validation
javadocClasspath jakartaLibs.cdi
javadocClasspath jakartaLibs.jacc
javadocClasspath jakartaLibs.jsonbApi
javadocClasspath libs.ant
javadocClasspath dbLibs.postgresql
javadocClasspath libs.jackson
javadocClasspath gradleApi()
javadocClasspath libs.jacksonXml
javadocClasspath dbLibs.oracle
}
2013-11-22 15:51:56 -05:00
if ( project.ormVersion.isSnapshot ) {
// only run the ci build tasks for SNAPSHOT versions
2023-04-01 10:33:34 -04:00
tasks.register('ciBuild') { dependsOn clean }
tasks.release.enabled false
}
else {
tasks.release.dependsOn clean
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// aggregated Javadoc
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
def aggregateJavadocsTask = tasks.register( "javadoc", Javadoc ) {
group = "documentation"
description = 'Builds JavaDoc aggregated across all ORM sub-projects'
destinationDir = mkdir( layout.buildDirectory.file( 'javadocs' ) )
source = configurations.javadocSources
classpath = configurations.javadocClasspath
configure( options ) {
overview = rootProject.file( "shared/javadoc/overview.html" )
windowTitle = 'Hibernate Javadocs'
docTitle = "Hibernate Javadoc ($project.version)"
}
if ( jdkVersions.explicit ) {
// setJFlags(
// getProperty( 'toolchain.javadoc.jvmargs' ).toString().
// split( ' ' ).toList().findAll( { !it.isEmpty() } )
// )
// Display version of Java tools
doFirst {
if ( javadocTool.present ) {
logger.lifecycle "Building aggregated javadoc with '${javadocTool.get().metadata.installationPath}'"
}
}
}
doFirst {
def javaLanguageVersion = javadocTool.present
? javadocTool.get().metadata.languageVersion
: JavaLanguageVersion.of( JavaVersion.current().name )
if ( javaLanguageVersion.asInt() > 11 ) {
println "Aggregated Javadocs are bing built` using a JDK newer than version 11: \n" +
"\t* `stylesheet.css` will not be compatible\n" +
"\t* generating the User Guide settings fragment will not succeed"
}
}
}
apply from: rootProject.file( 'gradle/javadoc.gradle' )
asciidoctorj {
requires 'rouge'
2023-05-11 10:54:58 -04:00
modules {
pdf {
version '2.3.7'
}
}
attributes icons: 'font',
experimental: true,
'source-highlighter': 'rouge',
majorMinorVersion: rootProject.ormVersion.family,
fullVersion: rootProject.ormVersion.fullName,
javaCompatibleVersions: jdks.versions.compatible.get(),
jakartaJpaVersion: rootProject.jakartaJpaVersion,
jdbcVersion: jdks.versions.jdbc.get()
options logDocuments: true
}
// Topical Guides ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
def renderTopicalGuideHtmlTask = tasks.register( 'renderTopicalGuideHtml', AsciidoctorTask ) { task ->
2023-05-11 10:54:58 -04:00
group = "Documentation"
2023-04-01 10:33:34 -04:00
description = 'Renders the Topical Guides in HTML format using Asciidoctor.'
inputs.property "hibernate-version", project.ormVersion
sourceDir = file( 'src/main/asciidoc/topical' )
outputDir = new File( "$buildDir/asciidoc/topical/html_single" )
resources {
from( 'src/main/asciidoc/topical/' ) {
include '**/images/**'
}
}
}
def renderTopicalGuidesTask = tasks.register( 'renderTopicalGuides', AsciidoctorTask ) { task ->
task.group = "Documentation"
task.description = 'Renders the Topical Guides in all formats.'
task.dependsOn renderTopicalGuideHtmlTask
}
// Getting Started Guides (quick starts) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2013-11-22 15:51:56 -05:00
def gettingStartedGuideHtmlDir = layout.buildDirectory.dir( "asciidoc/quickstart/html_single" )
def buildTutorialZipTask = tasks.register( 'buildTutorialZip', Zip ) { task ->
from 'src/main/asciidoc/quickstart/tutorials'
destinationDirectory.set( gettingStartedGuideHtmlDir )
archiveFileName = 'hibernate-tutorials.zip'
expand(
version: project.version,
slf4j: "2.0.7",
junit: testLibs.versions.junit4.get(),
h2: dbLibs.versions.h2.get()
)
}
def renderGettingStartedGuideHtmlTask = tasks.register( 'renderGettingStartedGuideHtmlTask', AsciidoctorTask ) { task ->
2023-05-11 10:54:58 -04:00
group = "Documentation"
description = 'Renders the Getting Started Guides (quickstarts) in HTML format using Asciidoctor.'
2023-04-01 10:33:34 -04:00
inputs.property "hibernate-version", project.ormVersion
finalizedBy buildTutorialZipTask
sourceDir = file( 'src/main/asciidoc/quickstart/guides' )
sources 'index.adoc'
outputDir = gettingStartedGuideHtmlDir
attributes linkcss: true,
stylesheet: "css/hibernate.css",
docinfo: 'private',
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
resources {
from( 'src/main/style/asciidoctor' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'css/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'js/**'
}
}
}
def renderGettingStartedGuidePdfTask = tasks.register( 'renderGettingStartedGuidePdf', AsciidoctorPdfTask ) { task ->
group = "Documentation"
description = 'Renders the Getting Started Guides in PDF format using Asciidoctor.'
inputs.property "hibernate-version", project.ormVersion
baseDir = file( 'src/main/asciidoc/quickstart/guides' )
sourceDir = file( 'src/main/asciidoc/quickstart/guides' )
sources 'index.adoc'
outputDir = layout.buildDirectory.dir( "asciidoc/quickstart/pdf" )
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
}
2016-02-11 16:59:13 -05:00
def renderGettingStartedGuidesTask = tasks.register( 'renderGettingStartedGuides' ) { task ->
task.group = "Documentation"
task.description = 'Renders the Getting Started Guide in all formats, as well as the acccompanying tutorial zip.'
task.dependsOn renderGettingStartedGuideHtmlTask, renderGettingStartedGuidePdfTask, buildTutorialZipTask
}
2016-02-11 16:59:13 -05:00
2023-05-11 10:54:58 -04:00
// Introduction ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-05-11 10:54:58 -04:00
def renderIntroductionHtmlTask = tasks.register( 'renderIntroductionHtml', AsciidoctorTask ) { task ->
2023-05-11 10:54:58 -04:00
group = "Documentation"
description = 'Renders the Introduction in HTML format using Asciidoctor.'
2023-05-11 10:54:58 -04:00
inputs.property "hibernate-version", project.ormVersion
sourceDir = file( 'src/main/asciidoc/introduction' )
sources 'Hibernate_Introduction.adoc'
outputDir = "$buildDir/asciidoc/introduction/html_single"
attributes linkcss: true,
stylesheet: "css/hibernate.css",
docinfo: 'private',
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
resources {
from( 'src/main/asciidoc/introduction/' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'css/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'js/**'
}
}
}
def renderIntroductionPdfTask = tasks.register( 'renderIntroductionPdf', AsciidoctorPdfTask ) { task ->
group = "Documentation"
description = 'Renders the Introduction in PDF format using Asciidoctor.'
inputs.property "hibernate-version", project.ormVersion
baseDir = file( 'src/main/asciidoc/introduction' )
sourceDir = file( 'src/main/asciidoc/introduction' )
sources 'Hibernate_Introduction.adoc'
outputDir = "$buildDir/asciidoc/introduction/pdf"
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
}
//noinspection GroovyUnusedAssignment
def renderIntroductionGuidesTask = tasks.register( "renderIntroductionGuides" ) { task ->
group = "Documentation"
description = 'Renders the Introduction Guide in all formats.'
task.dependsOn renderIntroductionHtmlTask, renderIntroductionPdfTask
tasks.buildDocs.dependsOn task
}
// HQL Guide ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
def renderQueryLanguageGuideHtmlTask = tasks.register( 'renderQueryLanguageGuideHtml', AsciidoctorTask ) { task ->
task.group = "Documentation"
task.description = 'Renders the Query Language document in HTML format using Asciidoctor.'
task.inputs.property "hibernate-version", project.ormVersion
task.sourceDir = file( 'src/main/asciidoc/querylanguage' )
task.sources 'Hibernate_Query_Language.adoc'
task.outputDir = layout.buildDirectory.dir( "asciidoc/querylanguage/html_single" )
task.attributes linkcss: true,
stylesheet: "css/hibernate.css",
docinfo: 'private',
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
task.resources {
from( 'src/main/asciidoc/querylanguage/' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'css/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'js/**'
}
}
}
def renderQueryLanguageGuidePdfTask = tasks.register( 'renderQueryLanguageGuidePdf', AsciidoctorPdfTask ) { task ->
group = "Documentation"
description = 'Renders the Query Language document in PDF format using Asciidoctor.'
inputs.property "hibernate-version", project.ormVersion
sourceDir = file( 'src/main/asciidoc/querylanguage' )
baseDir = file( 'src/main/asciidoc/querylanguage' )
sources {
include 'Hibernate_Query_Language.adoc'
}
outputDir = layout.buildDirectory.dir( "asciidoc/querylanguage/pdf" )
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
}
def renderRepositoriesHtmlTask = tasks.register( 'renderRepositoriesHtml', AsciidoctorTask ) { task ->
task.group = "Documentation"
task.description = 'Renders the Hibernate Data Repositories document in HTML format using Asciidoctor.'
task.inputs.property "hibernate-version", project.ormVersion
task.sourceDir = file( 'src/main/asciidoc/repositories' )
task.sources 'Hibernate_Data_Repositories.adoc'
task.outputDir = layout.buildDirectory.dir( "asciidoc/repositories/html_single" )
task.attributes linkcss: true,
stylesheet: "css/hibernate.css",
docinfo: 'private',
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
task.resources {
from( 'src/main/asciidoc/repositories/' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'css/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'js/**'
}
}
}
def renderRepositoriesPdfTask = tasks.register( 'renderRepositoriesPdf', AsciidoctorPdfTask ) { task ->
group = "Documentation"
description = 'Renders the Hibernate Data Repositories document in PDF format using Asciidoctor.'
inputs.property "hibernate-version", project.ormVersion
sourceDir = file( 'src/main/asciidoc/repositories' )
baseDir = file( 'src/main/asciidoc/repositories' )
sources {
include 'Hibernate_Data_Repositories.adoc'
}
outputDir = layout.buildDirectory.dir( "asciidoc/repositories/pdf" )
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
}
//noinspection GroovyUnusedAssignment
def renderQueryLanguageGuidesTask = tasks.register( 'renderQueryLanguageGuides' ) { task ->
group = "Documentation"
description = 'Renders Query Language Guide in all formats.'
task.dependsOn renderQueryLanguageGuideHtmlTask
task.dependsOn renderQueryLanguageGuidePdfTask
tasks.buildDocs.dependsOn task
}
//noinspection GroovyUnusedAssignment
def renderRepositoriesTask = tasks.register( 'renderRepositories' ) { task ->
group = "Documentation"
description = 'Renders Hibernate Data Repositories documentation in all formats.'
task.dependsOn renderRepositoriesHtmlTask
task.dependsOn renderRepositoriesPdfTask
tasks.buildDocs.dependsOn task
}
// User Guide ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
settingsDocumentation {
anchorNameBase = "settings"
sections {
compliance {
explicitPosition = 1
summary = "Jakarta Persistence Compliance Settings"
description = "Settings which control various aspects of compliance with the Jakarta Persistence specification "
settingsClassName "org.hibernate.cfg.JpaComplianceSettings"
}
persistence {
explicitPosition = 2
summary = "Persistence Unit Settings"
description = "Settings related to the creation and configuration of a persistence-unit - SessionFactory and EntityManagerFactory"
settingsClassName "org.hibernate.cfg.PersistenceSettings"
}
jdbc {
explicitPosition = 3
summary = "JDBC Settings"
description = "Settings which control various aspects of how Hibernate interacts with JDBC"
settingsClassName "org.hibernate.cfg.JdbcSettings"
}
c3p0 {
explicitPosition = 4
summary = "C3P0 Connection Pool Settings"
description = "Settings related to integrating with the C3P0 Connection pool"
settingsClassName "org.hibernate.cfg.C3p0Settings"
}
proxool {
explicitPosition = 5
summary = "Proxool Connection Pool Settings"
description = "Settings related to integrating with the Proxool Connection pool"
settingsClassName "org.hibernate.cfg.ProxoolSettings"
}
2023-12-20 20:49:08 -05:00
transaction {
explicitPosition = 6
2023-12-20 20:49:08 -05:00
summary = "Proxool Connection Pool Settings"
description = "Settings which control how Hibernate interacts with and manages transactions"
settingsClassName "org.hibernate.cfg.TransactionSettings"
}
mapping {
explicitPosition = 7
summary = "Domain Mapping Settings"
description = "Settings which control how domain mappings are handled"
settingsClassName "org.hibernate.cfg.MappingSettings"
}
2023-12-20 20:49:08 -05:00
fetch {
explicitPosition = 8
summary = "Fetch Related Settings"
description = "Settings which control aspects of fetching data from the database"
settingsClassName "org.hibernate.cfg.FetchSettings"
}
batch {
explicitPosition = 9
summary = "JDBC Batch Settings"
description = "Settings which control how Hibernate performs JDBC batching updating"
settingsClassName "org.hibernate.cfg.BatchSettings"
}
environment {
summary = "Runtime Environment Settings"
description = "Settings related to JNDI and ClassLoaders"
settingsClassName "org.hibernate.cfg.EnvironmentSettings"
}
2023-12-20 20:49:08 -05:00
tenancy {
summary = "Multi-tenancy Settings"
description = "Settings related multi-tenancy support"
settingsClassName "org.hibernate.cfg.MultiTenancySettings"
}
cdi {
summary = "CDI Settings"
description = "Settings related to CDI"
settingsClassName "org.hibernate.cfg.ManagedBeanSettings"
}
schema {
summary = "Schema Tooling Settings"
description = "Settings which control the creation, dropping, update and validation of database schemas"
settingsClassName "org.hibernate.cfg.SchemaToolingSettings"
}
bytecode {
summary = "Bytecode Manipulation Settings"
description = "Settings which control Hibernate's BytecodeProvider used for bytecode manipulation"
settingsClassName "org.hibernate.cfg.BytecodeSettings"
}
cache {
summary = "Second-level Cache Settings"
description = "Settings which control Hibernate's second-level caching"
settingsClassName "org.hibernate.cfg.CacheSettings"
settingsClassName "org.hibernate.cache.jcache.ConfigSettings"
}
query {
summary = "Query Settings"
description = "Settings which control various parts of Hibernate's Query handling"
settingsClassName "org.hibernate.cfg.QuerySettings"
}
stats {
summary = "Statistics Settings"
description = "Settings which control the collection of statistics"
settingsClassName "org.hibernate.cfg.StatisticsSettings"
}
validation {
summary = "Jakarta Validation Integeration Settings"
description = "Settings used in the integration of Jakarta Validation"
settingsClassName "org.hibernate.cfg.ValidationSettings"
}
dialect {
summary = "Dialect Specific Settings"
description = "Settings used for dialect configuration when the database isn't available"
settingsClassName "org.hibernate.cfg.DialectSpecificSettings"
}
envers {
summary = "Audit/History Settings"
description = "Settings which control Hibernate's audit/history support (hibernate-envers)"
settingsClassName "org.hibernate.envers.configuration.EnversSettings"
}
spatial {
summary = "Hibernate Spatial Settings"
description = "Settings which control Hibernate's support for spatial data (hibernate-spatial)"
settingsClassName "org.hibernate.spatial.HibernateSpatialConfigurationSettings"
settingsClassName "org.hibernate.spatial.integration.SpatialService"
}
2023-12-20 20:49:08 -05:00
session {
summary = "Session Event Settings"
description = "Settings related to Session events"
settingsClassName "org.hibernate.cfg.SessionEventSettings"
}
misc {
summary = "Miscellaneous Settings"
description = "Miscellaneous Settings"
settingsClassName "org.hibernate.cfg.AvailableSettings"
}
}
}
def generateSettingsDocTask = tasks.named( "generateSettingsDoc" ) {
dependsOn aggregateJavadocsTask
doFirst {
def javadoc = aggregateJavadocsTask.get()
def javaLanguageVersion = javadoc.javadocTool.present
? javadoc.javadocTool.get().metadata.languageVersion
: JavaLanguageVersion.of( JavaVersion.current().name )
if ( javaLanguageVersion.asInt() > 11 ) {
println "Aggregated Javadocs was built using a JDK newer than version 11; generating the settings User Guide fragment will not succeed"
}
}
}
def renderUserGuideHtmlTask = tasks.register( 'renderUserGuideHtml', AsciidoctorTask ) { task ->
2023-05-11 10:54:58 -04:00
group = "Documentation"
2023-04-01 10:33:34 -04:00
description = 'Renders the User Guides in HTML format using Asciidoctor.'
inputs.property "hibernate-version", project.ormVersion
inputs.file( generateSettingsDocTask.get().outputFile )
dependsOn generateSettingsDocTask, generateDialectTableReport
sourceDir = file( 'src/main/asciidoc/userguide' )
sources {
include 'Hibernate_User_Guide.adoc'
}
outputDir = "$buildDir/asciidoc/userguide/html_single"
attributes linkcss: true,
stylesheet: "css/hibernate.css",
docinfo: 'private',
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/",
'generated-report-dir': layout.buildDirectory.dir( 'orm/generated' ).get()
resources {
from( 'src/main/asciidoc/userguide/' ) {
2023-04-01 10:33:34 -04:00
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'css/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'js/**'
}
2023-04-01 10:33:34 -04:00
}
}
def renderUserGuidesTask = tasks.register( 'renderUserGuides' ) { task ->
task.group = "Documentation"
task.description = 'Renders the User Guides in all formats.'
task.dependsOn( renderUserGuideHtmlTask )
}
// Integration Guide ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
def renderIntegrationGuideHtmlTask = tasks.register( "renderIntegrationGuideHtml", AsciidoctorTask ) { task->
2023-04-01 10:33:34 -04:00
group = "Documentation"
description = 'Renders the User Guides in HTML format using Asciidoctor.'
2023-04-01 10:33:34 -04:00
inputs.property "hibernate-version", project.ormVersion
sourceDir = file( 'src/main/asciidoc/integrationguide' )
sources {
include 'Hibernate_Integration_Guide.adoc'
}
2022-03-31 12:01:06 -04:00
outputDir = project.layout.buildDirectory.dir( 'asciidoc/integrationguide/html_single' )
attributes linkcss: true,
stylesheet: "css/hibernate.css"
resources {
from( 'src/main/asciidoc/integrationguide/' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'css/**'
}
}
}
def renderIntegrationGuidesTask = tasks.register( "renderIntegrationGuides" ) { task ->
group = "Documentation"
description = 'Renders all formats of the User Guide.'
task.dependsOn renderIntegrationGuideHtmlTask
tasks.buildDocs.dependsOn task
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Migration Guide
def migrationGuideSourceStagingDir = layout.buildDirectory.dir( "tmp/asciidoc/migration-guide" )
def copyMigrationGuideTask = tasks.register( "copyMigrationGuide", Copy ) {task ->
group = "Documentation"
description = "Copies migration-guide.adoc in preparation for rendering."
inputs.property "hibernate-version", project.ormVersion
from rootProject.layout.projectDirectory.file( "migration-guide.adoc" )
into migrationGuideSourceStagingDir
}
def renderMigrationGuideTask = tasks.register( "renderMigrationGuide", AsciidoctorTask ) { task ->
2023-04-01 10:33:34 -04:00
group = "Documentation"
description = "Renders the Migration Guide in HTML format using Asciidoctor."
dependsOn copyMigrationGuideTask
2023-04-01 10:33:34 -04:00
inputs.property "hibernate-version", project.ormVersion
sourceDir = migrationGuideSourceStagingDir
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/**'
}
}
}
2022-03-31 12:01:06 -04:00
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// ORM Reports
def renderLoggingReportTask = tasks.register( 'renderLoggingReport', AsciidoctorTask ) { task ->
task.group = "hibernate-reports"
task.description = 'Renders the logging report (generated LoggingReportTask) by in HTML format using Asciidoctor.'
task.dependsOn "generateLoggingReport"
2022-03-31 12:01:06 -04:00
task.inputs.property "version", project.ormVersion
2022-03-31 12:01:06 -04:00
task.sourceDir = layout.buildDirectory.dir( 'orm/generated/logging' )
task.sources 'logging.adoc'
2022-03-31 12:01:06 -04:00
task.outputDir = project.layout.buildDirectory.dir( 'asciidoc/logging' )
2022-03-31 12:01:06 -04:00
task.attributes linkcss: true,
stylesheet: "css/hibernate.css"
2022-03-31 12:01:06 -04:00
task.resources {
from( 'src/main/style/asciidoctor' ) {
2022-03-31 12:01:06 -04:00
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
2022-03-31 12:01:06 -04:00
include 'css/**'
}
}
}
def renderDialectReportTask = tasks.register( 'renderDialectReport', AsciidoctorTask ) { task ->
task.group = "hibernate-reports"
task.description = 'Renders the supported Dialect report in HTML format using Asciidoctor.'
task.dependsOn "generateDialectReport"
task.dependsOn "generateDialectTableReport"
task.inputs.property "version", project.ormVersion
task.sourceDir = layout.buildDirectory.dir( 'orm/generated/dialect' )
task.sources 'dialect.adoc'
task.outputDir = project.layout.buildDirectory.dir( 'asciidoc/dialect' )
task.attributes linkcss: true,
stylesheet: "css/hibernate.css"
task.resources {
from( 'src/main/style/asciidoctor' ) {
include 'images/**'
}
from( 'src/main/style/asciidoctor' ) {
include 'css/**'
}
}
}
def generateReportsTask = tasks.named( "generateReports" ) {
dependsOn renderLoggingReportTask, renderDialectReportTask
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Overall grouping tasks
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
def buildDocsTask = tasks.register( 'buildDocs' ) { task ->
task.group = 'Documentation'
task.description = 'Grouping task for performing all documentation building tasks'
task.dependsOn aggregateJavadocsTask
task.dependsOn renderGettingStartedGuidesTask
task.dependsOn renderIntroductionGuidesTask
task.dependsOn renderUserGuidesTask
task.dependsOn renderQueryLanguageGuidesTask
task.dependsOn renderRepositoriesTask
task.dependsOn renderIntegrationGuidesTask
task.dependsOn renderTopicalGuidesTask
task.dependsOn generateReportsTask
task.dependsOn renderMigrationGuideTask
}
//noinspection GroovyUnusedAssignment
def buildDocsForPublishingTask = tasks.register( 'buildDocsForPublishing' ) { task ->
task.group = 'Documentation'
task.description = 'Grouping task for building all documentation for publishing (release)'
task.dependsOn buildDocsTask
}
2022-03-31 12:01:06 -04:00
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2022-03-11 15:45:43 -05:00
tasks.withType(AsciidoctorTask).configureEach {
2021-08-05 11:04:54 -04:00
baseDirFollowsSourceDir()
outputOptions {
separateOutputDirs = false
backends 'html5'
}
}