Skip to content

Commit d3398e5

Browse files
committed
HHH-19827 Render index.htmls instead of some-name.htmls
1 parent 11be8ba commit d3398e5

File tree

8 files changed

+47
-17
lines changed

8 files changed

+47
-17
lines changed

documentation/documentation.gradle

Lines changed: 45 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -362,9 +362,9 @@ def renderIntroductionHtmlTask = tasks.register( 'renderIntroductionHtml', Ascii
362362
inputs.property "hibernate-version", hibernateVersion
363363

364364
sourceDir = file( 'src/main/asciidoc/introduction' )
365-
sources 'Hibernate_Introduction.adoc'
365+
sources 'index.adoc'
366366

367-
outputDir = "$buildDir/asciidoc/introduction/html_single"
367+
outputDir = layout.buildDirectory.dir("asciidoc/introduction/html_single")
368368

369369
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
370370

@@ -389,11 +389,17 @@ def renderIntroductionPdfTask = tasks.register( 'renderIntroductionPdf', Asciido
389389
baseDir = file( 'src/main/asciidoc/introduction' )
390390

391391
sourceDir = file( 'src/main/asciidoc/introduction' )
392-
sources 'Hibernate_Introduction.adoc'
392+
sources 'index.adoc'
393393

394-
outputDir = "$buildDir/asciidoc/introduction/pdf"
394+
395+
def output = layout.buildDirectory.dir("asciidoc/introduction/pdf")
396+
outputDir = output
395397

396398
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
399+
400+
doLast {
401+
output.get().file('index.pdf').asFile.renameTo(output.get().file('Hibernate_Introduction.pdf').asFile)
402+
}
397403
}
398404

399405
//noinspection GroovyUnusedAssignment
@@ -415,7 +421,7 @@ def renderQueryLanguageGuideHtmlTask = tasks.register( 'renderQueryLanguageGuide
415421
task.inputs.property "hibernate-version", hibernateVersion
416422

417423
task.sourceDir = file( 'src/main/asciidoc/querylanguage' )
418-
task.sources 'Hibernate_Query_Language.adoc'
424+
task.sources 'index.adoc'
419425

420426
task.outputDir = layout.buildDirectory.dir( "asciidoc/querylanguage/html_single" )
421427

@@ -443,11 +449,16 @@ def renderQueryLanguageGuidePdfTask = tasks.register( 'renderQueryLanguageGuideP
443449
sourceDir = file( 'src/main/asciidoc/querylanguage' )
444450
baseDir = file( 'src/main/asciidoc/querylanguage' )
445451
sources {
446-
include 'Hibernate_Query_Language.adoc'
452+
include 'index.adoc'
447453
}
448-
outputDir = layout.buildDirectory.dir( "asciidoc/querylanguage/pdf" )
454+
def output = layout.buildDirectory.dir("asciidoc/querylanguage/pdf")
455+
outputDir = output
449456

450457
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
458+
459+
doLast {
460+
output.get().file('index.pdf').asFile.renameTo(output.get().file('Hibernate_Query_Language.pdf').asFile)
461+
}
451462
}
452463

453464
def renderRepositoriesHtmlTask = tasks.register( 'renderRepositoriesHtml', AsciidoctorTask ) { task ->
@@ -457,7 +468,7 @@ def renderRepositoriesHtmlTask = tasks.register( 'renderRepositoriesHtml', Ascii
457468
task.inputs.property "hibernate-version", hibernateVersion
458469

459470
task.sourceDir = file( 'src/main/asciidoc/repositories' )
460-
task.sources 'Hibernate_Data_Repositories.adoc'
471+
task.sources 'index.adoc'
461472

462473
task.outputDir = layout.buildDirectory.dir( "asciidoc/repositories/html_single" )
463474

@@ -485,11 +496,16 @@ def renderRepositoriesPdfTask = tasks.register( 'renderRepositoriesPdf', Asciido
485496
sourceDir = file( 'src/main/asciidoc/repositories' )
486497
baseDir = file( 'src/main/asciidoc/repositories' )
487498
sources {
488-
include 'Hibernate_Data_Repositories.adoc'
499+
include 'index.adoc'
489500
}
490-
outputDir = layout.buildDirectory.dir( "asciidoc/repositories/pdf" )
501+
def output = layout.buildDirectory.dir("asciidoc/repositories/pdf")
502+
outputDir = output
491503

492504
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
505+
506+
doLast {
507+
output.get().file('index.pdf').asFile.renameTo(output.get().file('Hibernate_Data_Repositories.pdf').asFile)
508+
}
493509
}
494510

495511
//noinspection GroovyUnusedAssignment
@@ -667,9 +683,9 @@ def renderUserGuideHtmlTask = tasks.register( 'renderUserGuideHtml', Asciidoctor
667683

668684
sourceDir = file( 'src/main/asciidoc/userguide' )
669685
sources {
670-
include 'Hibernate_User_Guide.adoc'
686+
include 'index.adoc'
671687
}
672-
outputDir = "$buildDir/asciidoc/userguide/html_single"
688+
outputDir = layout.buildDirectory.dir("asciidoc/userguide/html_single")
673689

674690
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/",
675691
'generated-report-dir': layout.buildDirectory.dir( 'orm/generated' ).get()
@@ -703,7 +719,7 @@ def renderIntegrationGuideHtmlTask = tasks.register( "renderIntegrationGuideHtml
703719

704720
sourceDir = file( 'src/main/asciidoc/integrationguide' )
705721
sources {
706-
include 'Hibernate_Integration_Guide.adoc'
722+
include 'index.adoc'
707723
}
708724

709725
outputDir = project.layout.buildDirectory.dir( 'asciidoc/integrationguide/html_single' )
@@ -743,6 +759,13 @@ def copyWhatsNewTask = tasks.register( "copyWhatsNew", Copy ) {task ->
743759

744760
from rootProject.layout.projectDirectory.file( "whats-new.adoc" )
745761
into whatsNewGuideSourceStagingDir
762+
763+
rename { fileName ->
764+
if (fileName == 'whats-new.adoc') {
765+
return 'index.adoc'
766+
}
767+
return fileName
768+
}
746769
}
747770

748771
def renderWhatsNewTask = tasks.register( "renderWhatsNew", AsciidoctorTask ) {
@@ -779,6 +802,13 @@ def copyMigrationGuideTask = tasks.register( "copyMigrationGuide", Copy ) {task
779802

780803
from rootProject.layout.projectDirectory.file( "migration-guide.adoc" )
781804
into migrationGuideSourceStagingDir
805+
806+
rename { fileName ->
807+
if (fileName == 'migration-guide.adoc') {
808+
return 'index.adoc'
809+
}
810+
return fileName
811+
}
782812
}
783813

784814
def renderMigrationGuideTask = tasks.register( "renderMigrationGuide", AsciidoctorTask ) { task ->
@@ -814,7 +844,7 @@ def renderLoggingReportTask = tasks.register( 'renderLoggingReport', Asciidoctor
814844
task.inputs.property "version", hibernateVersion
815845

816846
task.sourceDir = layout.buildDirectory.dir( 'orm/generated/logging' )
817-
task.sources 'logging.adoc'
847+
task.sources 'index.adoc'
818848

819849
task.outputDir = project.layout.buildDirectory.dir( 'asciidoc/logging' )
820850

@@ -837,7 +867,7 @@ def renderDialectReportTask = tasks.register( 'renderDialectReport', Asciidoctor
837867
task.inputs.property "version", hibernateVersion
838868

839869
task.sourceDir = layout.buildDirectory.dir( 'orm/generated/dialect' )
840-
task.sources 'dialect.adoc'
870+
task.sources 'index.adoc'
841871

842872
task.outputDir = project.layout.buildDirectory.dir( 'asciidoc/dialect' )
843873

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

local-build-plugins/src/main/java/org/hibernate/orm/post/DialectReportTask.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public abstract class DialectReportTask extends AbstractJandexAwareTask {
4444
public DialectReportTask() {
4545
setDescription( "Generates a report of the supported Dialects" );
4646
reportFile = getProject().getObjects().fileProperty();
47-
reportFile.convention( getProject().getLayout().getBuildDirectory().file( "orm/generated/dialect/dialect.adoc" ) );
47+
reportFile.convention( getProject().getLayout().getBuildDirectory().file( "orm/generated/dialect/index.adoc" ) );
4848
generateHeading = getProject().getObjects().property( Boolean.class ).convention( true );
4949
}
5050

local-build-plugins/src/main/java/org/hibernate/orm/post/LoggingReportTask.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public abstract class LoggingReportTask extends AbstractJandexAwareTask {
4949
public LoggingReportTask() {
5050
setDescription( "Generates a report of \"system\" logging" );
5151
reportFile = getProject().getObjects().fileProperty();
52-
reportFile.convention( getProject().getLayout().getBuildDirectory().file( "orm/generated/logging/logging.adoc" ) );
52+
reportFile.convention( getProject().getLayout().getBuildDirectory().file( "orm/generated/logging/index.adoc" ) );
5353
}
5454

5555
@Override

0 commit comments

Comments
 (0)