Skip to content

Commit 854c375

Browse files
gregturngregturn
committed
Polishing.
* Move Antora-based documentation underneath src/main/antora. * Put Antora build process behind a maven profile so it doesn't run on standard CI jobs. * Refine build process so that final document includes injected build properties. * Drop epub artwork since we no longer publish that. See #2876
1 parent 876e319 commit 854c375

39 files changed

+95
-99
lines changed

‎antora-playbook.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ antora:
88
root_component_name: 'data-commons'
99
site:
1010
title: Spring Data Reference
11-
url: https://https://rwinch.github.io/spring-data-commons/
11+
url: https://rwinch.github.io/spring-data-commons/
1212
content:
1313
sources:
1414
- url: .
1515
branches: HEAD
16-
start_path: .
16+
start_path: src/main/antora
1717
worktrees: true
1818
asciidoc:
1919
attributes:

‎modules/ROOT/assets/images/epub-cover.png‎

-58.3 KB
Binary file not shown.

‎modules/ROOT/assets/images/epub-cover.svg‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎pom.xml‎

Lines changed: 90 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -366,90 +366,99 @@
366366
<groupId>org.apache.maven.plugins</groupId>
367367
<artifactId>maven-assembly-plugin</artifactId>
368368
</plugin>
369-
<plugin>
370-
<groupId>com.github.eirslett</groupId>
371-
<artifactId>frontend-maven-plugin</artifactId>
372-
<version>1.12.1</version>
373-
<executions>
374-
<execution>
375-
<id>install node and npm</id>
376-
<goals>
377-
<goal>install-node-and-npm</goal>
378-
</goals>
379-
<phase>initialize</phase>
380-
<configuration>
381-
<nodeVersion>${node.version}</nodeVersion>
382-
<npmVersion>${npm.version}</npmVersion>
383-
</configuration>
384-
</execution>
385-
<execution>
386-
<id>npm install antora</id>
387-
<goals>
388-
<goal>npm</goal>
389-
</goals>
390-
<phase>initialize</phase>
391-
<configuration>
392-
<arguments>install @antora/cli@${antora.version} @antora/site-generator-default@${antora.version} @antora/atlas-extension@${antora-atlas.version} @antora/collector-extension@${antora-collector.version} @asciidoctor/tabs@${asciidoctor-tabs.version} @springio/antora-extensions@${spring-antora-extensions.version} @springio/asciidoctor-extensions@${spring-asciidoctor-extensions.version}</arguments>
393-
</configuration>
394-
</execution>
395-
</executions>
396-
</plugin>
397-
<plugin>
398-
<groupId>org.codehaus.mojo</groupId>
399-
<artifactId>exec-maven-plugin</artifactId>
400-
<version>3.0.0</version>
401-
<executions>
402-
<execution>
403-
<id>antora</id>
404-
<goals>
405-
<goal>exec</goal>
406-
</goals>
407-
<phase>compile</phase>
408-
<configuration>
409-
<!-- If we don't want to depend on default node installation path we can use a maven
410-
property aligned with frontend-maven-plugin's installDirectory configuration -->
411-
<executable>node/node</executable>
412-
<arguments>
413-
<argument>node_modules/.bin/antora</argument>
414-
<argument>antora-playbook.yml</argument>
415-
<argument>--to-dir=target/site</argument>
416-
</arguments>
417-
<workingDirectory>${project.basedir}</workingDirectory>
418-
</configuration>
419-
</execution>
420-
</executions>
421-
</plugin>
422-
<plugin>
423-
<groupId>org.apache.maven.plugins</groupId>
424-
<artifactId>maven-clean-plugin</artifactId>
425-
<version>3.1.0</version>
426-
<configuration>
427-
<filesets>
428-
<fileset>
429-
<directory>node</directory>
430-
<followSymlinks>false</followSymlinks>
431-
</fileset>
432-
<fileset>
433-
<directory>node_modules</directory>
434-
<followSymlinks>false</followSymlinks>
435-
</fileset>
436-
<fileset>
437-
<directory>build</directory>
438-
<followSymlinks>false</followSymlinks>
439-
</fileset>
440-
</filesets>
441-
</configuration>
442-
</plugin>
443-
444369
</plugins>
445-
<resources>
446-
<resource>
447-
<directory>src/main/resources</directory>
448-
<filtering>true</filtering>
449-
</resource>
450-
</resources>
451370
</build>
452371

372+
<profiles>
373+
<profile>
374+
<id>docs</id>
375+
<build>
376+
<plugins>
377+
<plugin>
378+
<groupId>com.github.eirslett</groupId>
379+
<artifactId>frontend-maven-plugin</artifactId>
380+
<version>1.12.1</version>
381+
<executions>
382+
<execution>
383+
<id>install node and npm</id>
384+
<goals>
385+
<goal>install-node-and-npm</goal>
386+
</goals>
387+
<phase>initialize</phase>
388+
<configuration>
389+
<nodeVersion>${node.version}</nodeVersion>
390+
<npmVersion>${npm.version}</npmVersion>
391+
</configuration>
392+
</execution>
393+
<execution>
394+
<id>npm install antora</id>
395+
<goals>
396+
<goal>npm</goal>
397+
</goals>
398+
<phase>initialize</phase>
399+
<configuration>
400+
<arguments>install @antora/cli@${antora.version} @antora/site-generator-default@${antora.version} @antora/atlas-extension@${antora-atlas.version} @antora/collector-extension@${antora-collector.version} @asciidoctor/tabs@${asciidoctor-tabs.version} @springio/antora-extensions@${spring-antora-extensions.version} @springio/asciidoctor-extensions@${spring-asciidoctor-extensions.version}</arguments>
401+
</configuration>
402+
</execution>
403+
</executions>
404+
</plugin>
405+
<plugin>
406+
<groupId>org.codehaus.mojo</groupId>
407+
<artifactId>exec-maven-plugin</artifactId>
408+
<version>3.0.0</version>
409+
<executions>
410+
<execution>
411+
<id>antora</id>
412+
<goals>
413+
<goal>exec</goal>
414+
</goals>
415+
<phase>compile</phase>
416+
<configuration>
417+
<!-- If we don't want to depend on default node installation path we can use a maven
418+
property aligned with frontend-maven-plugin's installDirectory configuration -->
419+
<executable>node/node</executable>
420+
<arguments>
421+
<argument>node_modules/.bin/antora</argument>
422+
<argument>antora-playbook.yml</argument>
423+
<argument>--to-dir=target/site</argument>
424+
</arguments>
425+
<workingDirectory>${project.basedir}</workingDirectory>
426+
</configuration>
427+
</execution>
428+
</executions>
429+
</plugin>
430+
<plugin>
431+
<groupId>org.apache.maven.plugins</groupId>
432+
<artifactId>maven-clean-plugin</artifactId>
433+
<version>3.1.0</version>
434+
<configuration>
435+
<filesets>
436+
<fileset>
437+
<directory>node</directory>
438+
<followSymlinks>false</followSymlinks>
439+
</fileset>
440+
<fileset>
441+
<directory>node_modules</directory>
442+
<followSymlinks>false</followSymlinks>
443+
</fileset>
444+
<fileset>
445+
<directory>build</directory>
446+
<followSymlinks>false</followSymlinks>
447+
</fileset>
448+
</filesets>
449+
</configuration>
450+
</plugin>
451+
</plugins>
452+
<resources>
453+
<resource>
454+
<directory>src/main/resources</directory>
455+
<filtering>true</filtering>
456+
</resource>
457+
</resources>
458+
</build>
459+
</profile>
460+
</profiles>
461+
453462
<repositories>
454463
<repository>
455464
<id>spring-snapshot</id>

antora.yml renamed to src/main/antora/antora.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav:
66
ext:
77
collector:
88
- run:
9-
command: mvnw resources:resources
9+
command: mvnw -Pdocs resources:resources
1010
local: true
1111
scan:
12-
dir: ./target/classes/antora-resources
12+
dir: target/classes/antora-resources

modules/ROOT/nav.adoc renamed to src/main/antora/modules/ROOT/nav.adoc

File renamed without changes.

modules/ROOT/pages/auditing.adoc renamed to src/main/antora/modules/ROOT/pages/auditing.adoc

File renamed without changes.

modules/ROOT/pages/custom-conversions.adoc renamed to src/main/antora/modules/ROOT/pages/custom-conversions.adoc

File renamed without changes.

modules/ROOT/pages/dependencies.adoc renamed to src/main/antora/modules/ROOT/pages/dependencies.adoc

File renamed without changes.

modules/ROOT/pages/entity-callbacks.adoc renamed to src/main/antora/modules/ROOT/pages/entity-callbacks.adoc

File renamed without changes.

0 commit comments

Comments
 (0)