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
spring-projects · Jul 19, 2023 · 854c375 · 854c375
1 parent 876e319
commit 854c375
Show file tree

Hide file tree

Showing 39 changed files with 95 additions and 99 deletions.
diff --git a/antora-playbook.yml b/antora-playbook.yml
@@ -8,12 +8,12 @@ antora:
       root_component_name: 'data-commons'
 site:
   title: Spring Data Reference
-  url: https://https://rwinch.github.io/spring-data-commons/
+  url: https://rwinch.github.io/spring-data-commons/
 content:
   sources:
     - url: .
       branches: HEAD
-      start_path: .
+      start_path: src/main/antora
       worktrees: true
 asciidoc:
   attributes:

diff --git a/modules/ROOT/assets/images/epub-cover.png b/modules/ROOT/assets/images/epub-cover.png
diff --git a/modules/ROOT/assets/images/epub-cover.svg b/modules/ROOT/assets/images/epub-cover.svg
diff --git a/pom.xml b/pom.xml
@@ -366,90 +366,99 @@
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-assembly-plugin</artifactId>
 			</plugin>
-			<plugin>
-				<groupId>com.github.eirslett</groupId>
-				<artifactId>frontend-maven-plugin</artifactId>
-				<version>1.12.1</version>
-				<executions>
-					<execution>
-						<id>install node and npm</id>
-						<goals>
-							<goal>install-node-and-npm</goal>
-						</goals>
-						<phase>initialize</phase>
-						<configuration>
-							<nodeVersion>${node.version}</nodeVersion>
-							<npmVersion>${npm.version}</npmVersion>
-						</configuration>
-					</execution>
-					<execution>
-						<id>npm install antora</id>
-						<goals>
-							<goal>npm</goal>
-						</goals>
-						<phase>initialize</phase>
-						<configuration>
-							<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>
-						</configuration>
-					</execution>
-				</executions>
-			</plugin>
-			<plugin>
-				<groupId>org.codehaus.mojo</groupId>
-				<artifactId>exec-maven-plugin</artifactId>
-				<version>3.0.0</version>
-				<executions>
-					<execution>
-						<id>antora</id>
-						<goals>
-							<goal>exec</goal>
-						</goals>
-						<phase>compile</phase>
-						<configuration>
-							<!-- If we don't want to depend on default node installation path we can use a maven
-							 property aligned with frontend-maven-plugin's installDirectory configuration -->
-							<executable>node/node</executable>
-							<arguments>
-								<argument>node_modules/.bin/antora</argument>
-								<argument>antora-playbook.yml</argument>
-								<argument>--to-dir=target/site</argument>
-							</arguments>
-							<workingDirectory>${project.basedir}</workingDirectory>
-						</configuration>
-					</execution>
-				</executions>
-			</plugin>
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-clean-plugin</artifactId>
-				<version>3.1.0</version>
-				<configuration>
-					<filesets>
-						<fileset>
-							<directory>node</directory>
-							<followSymlinks>false</followSymlinks>
-						</fileset>
-						<fileset>
-							<directory>node_modules</directory>
-							<followSymlinks>false</followSymlinks>
-						</fileset>
-						<fileset>
-							<directory>build</directory>
-							<followSymlinks>false</followSymlinks>
-						</fileset>
-					</filesets>
-				</configuration>
-			</plugin>
-
 		</plugins>
-		<resources>
-			<resource>
-				<directory>src/main/resources</directory>
-				<filtering>true</filtering>
-			</resource>
-		</resources>
 	</build>
 
+	<profiles>
+		<profile>
+			<id>docs</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>com.github.eirslett</groupId>
+						<artifactId>frontend-maven-plugin</artifactId>
+						<version>1.12.1</version>
+						<executions>
+							<execution>
+								<id>install node and npm</id>
+								<goals>
+									<goal>install-node-and-npm</goal>
+								</goals>
+								<phase>initialize</phase>
+								<configuration>
+									<nodeVersion>${node.version}</nodeVersion>
+									<npmVersion>${npm.version}</npmVersion>
+								</configuration>
+							</execution>
+							<execution>
+								<id>npm install antora</id>
+								<goals>
+									<goal>npm</goal>
+								</goals>
+								<phase>initialize</phase>
+								<configuration>
+									<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>
+								</configuration>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.codehaus.mojo</groupId>
+						<artifactId>exec-maven-plugin</artifactId>
+						<version>3.0.0</version>
+						<executions>
+							<execution>
+								<id>antora</id>
+								<goals>
+									<goal>exec</goal>
+								</goals>
+								<phase>compile</phase>
+								<configuration>
+									<!-- If we don't want to depend on default node installation path we can use a maven
+                                     property aligned with frontend-maven-plugin's installDirectory configuration -->
+									<executable>node/node</executable>
+									<arguments>
+										<argument>node_modules/.bin/antora</argument>
+										<argument>antora-playbook.yml</argument>
+										<argument>--to-dir=target/site</argument>
+									</arguments>
+									<workingDirectory>${project.basedir}</workingDirectory>
+								</configuration>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-clean-plugin</artifactId>
+						<version>3.1.0</version>
+						<configuration>
+							<filesets>
+								<fileset>
+									<directory>node</directory>
+									<followSymlinks>false</followSymlinks>
+								</fileset>
+								<fileset>
+									<directory>node_modules</directory>
+									<followSymlinks>false</followSymlinks>
+								</fileset>
+								<fileset>
+									<directory>build</directory>
+									<followSymlinks>false</followSymlinks>
+								</fileset>
+							</filesets>
+						</configuration>
+					</plugin>
+				</plugins>
+				<resources>
+					<resource>
+						<directory>src/main/resources</directory>
+						<filtering>true</filtering>
+					</resource>
+				</resources>
+			</build>
+		</profile>
+	</profiles>
+
 	<repositories>
 		<repository>
 			<id>spring-snapshot</id>

diff --git a/antora.yml → src/main/antora/antora.yml b/antora.yml → src/main/antora/antora.yml
@@ -6,7 +6,7 @@ nav:
 ext:
   collector:
     - run:
-        command: mvnw resources:resources
+        command: mvnw -Pdocs resources:resources
         local: true
       scan:
-        dir: ./target/classes/antora-resources
+        dir: target/classes/antora-resources
diff --git a/modules/ROOT/nav.adoc → src/main/antora/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc → src/main/antora/modules/ROOT/nav.adoc
diff --git a/modules/ROOT/pages/auditing.adoc → ...n/antora/modules/ROOT/pages/auditing.adoc b/modules/ROOT/pages/auditing.adoc → ...n/antora/modules/ROOT/pages/auditing.adoc
diff --git a/modules/ROOT/pages/custom-conversions.adoc → ...odules/ROOT/pages/custom-conversions.adoc b/modules/ROOT/pages/custom-conversions.adoc → ...odules/ROOT/pages/custom-conversions.adoc
diff --git a/modules/ROOT/pages/dependencies.adoc → ...tora/modules/ROOT/pages/dependencies.adoc b/modules/ROOT/pages/dependencies.adoc → ...tora/modules/ROOT/pages/dependencies.adoc
diff --git a/modules/ROOT/pages/entity-callbacks.adoc → .../modules/ROOT/pages/entity-callbacks.adoc b/modules/ROOT/pages/entity-callbacks.adoc → .../modules/ROOT/pages/entity-callbacks.adoc
diff --git a/modules/ROOT/pages/index.adoc → ...main/antora/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc → ...main/antora/modules/ROOT/pages/index.adoc
@@ -4,7 +4,6 @@ Oliver Gierke; Thomas Darimont; Christoph Strobl; Mark Pollack; Thomas Risberg;
 :revnumber: {version}
 :revdate: {localdate}
 :feature-scroll: true
-ifdef::backend-epub3[:front-cover-image: image:epub-cover.png[Front Cover,1050,1600]]
 
 (C) 2008-2022 The original authors.
 

diff --git a/...es/ROOT/pages/is-new-state-detection.adoc → ...es/ROOT/pages/is-new-state-detection.adoc b/...es/ROOT/pages/is-new-state-detection.adoc → ...es/ROOT/pages/is-new-state-detection.adoc
diff --git a/modules/ROOT/pages/kotlin.adoc → ...ain/antora/modules/ROOT/pages/kotlin.adoc b/modules/ROOT/pages/kotlin.adoc → ...ain/antora/modules/ROOT/pages/kotlin.adoc
diff --git a/modules/ROOT/pages/kotlin/coroutines.adoc → ...modules/ROOT/pages/kotlin/coroutines.adoc b/modules/ROOT/pages/kotlin/coroutines.adoc → ...modules/ROOT/pages/kotlin/coroutines.adoc
diff --git a/modules/ROOT/pages/kotlin/extensions.adoc → ...modules/ROOT/pages/kotlin/extensions.adoc b/modules/ROOT/pages/kotlin/extensions.adoc → ...modules/ROOT/pages/kotlin/extensions.adoc
diff --git a/modules/ROOT/pages/kotlin/null-safety.adoc → ...odules/ROOT/pages/kotlin/null-safety.adoc b/modules/ROOT/pages/kotlin/null-safety.adoc → ...odules/ROOT/pages/kotlin/null-safety.adoc
diff --git a/...les/ROOT/pages/kotlin/object-mapping.adoc → ...les/ROOT/pages/kotlin/object-mapping.adoc b/...les/ROOT/pages/kotlin/object-mapping.adoc → ...les/ROOT/pages/kotlin/object-mapping.adoc
diff --git a/modules/ROOT/pages/kotlin/requirements.adoc → ...dules/ROOT/pages/kotlin/requirements.adoc b/modules/ROOT/pages/kotlin/requirements.adoc → ...dules/ROOT/pages/kotlin/requirements.adoc
diff --git a/modules/ROOT/pages/object-mapping.adoc → ...ra/modules/ROOT/pages/object-mapping.adoc b/modules/ROOT/pages/object-mapping.adoc → ...ra/modules/ROOT/pages/object-mapping.adoc
diff --git a/modules/ROOT/pages/query-by-example.adoc → .../modules/ROOT/pages/query-by-example.adoc b/modules/ROOT/pages/query-by-example.adoc → .../modules/ROOT/pages/query-by-example.adoc
diff --git a/...OOT/pages/repositories-null-handling.adoc → ...OOT/pages/repositories-null-handling.adoc b/...OOT/pages/repositories-null-handling.adoc → ...OOT/pages/repositories-null-handling.adoc
diff --git a/...es/ROOT/pages/repositories-scrolling.adoc → ...es/ROOT/pages/repositories-scrolling.adoc b/...es/ROOT/pages/repositories-scrolling.adoc → ...es/ROOT/pages/repositories-scrolling.adoc
diff --git a/modules/ROOT/pages/repositories.adoc → ...tora/modules/ROOT/pages/repositories.adoc b/modules/ROOT/pages/repositories.adoc → ...tora/modules/ROOT/pages/repositories.adoc
diff --git a/...OOT/pages/repositories/core-concepts.adoc → ...OOT/pages/repositories/core-concepts.adoc b/...OOT/pages/repositories/core-concepts.adoc → ...OOT/pages/repositories/core-concepts.adoc
diff --git a/...ages/repositories/core-domain-events.adoc → ...ages/repositories/core-domain-events.adoc b/...ages/repositories/core-domain-events.adoc → ...ages/repositories/core-domain-events.adoc
diff --git a/...T/pages/repositories/core-extensions.adoc → ...T/pages/repositories/core-extensions.adoc b/...T/pages/repositories/core-extensions.adoc → ...T/pages/repositories/core-extensions.adoc
diff --git a/.../pages/repositories/create-instances.adoc → .../pages/repositories/create-instances.adoc b/.../pages/repositories/create-instances.adoc → .../pages/repositories/create-instances.adoc
diff --git a/.../repositories/custom-implementations.adoc → .../repositories/custom-implementations.adoc b/.../repositories/custom-implementations.adoc → .../repositories/custom-implementations.adoc
diff --git a/...s/ROOT/pages/repositories/definition.adoc → ...s/ROOT/pages/repositories/definition.adoc b/...s/ROOT/pages/repositories/definition.adoc → ...s/ROOT/pages/repositories/definition.adoc
diff --git a/...s/repositories/query-methods-details.adoc → ...s/repositories/query-methods-details.adoc b/...s/repositories/query-methods-details.adoc → ...s/repositories/query-methods-details.adoc
diff --git a/...OOT/pages/repositories/query-methods.adoc → ...OOT/pages/repositories/query-methods.adoc b/...OOT/pages/repositories/query-methods.adoc → ...OOT/pages/repositories/query-methods.adoc
diff --git a/...pages/repository-namespace-reference.adoc → ...pages/repository-namespace-reference.adoc b/...pages/repository-namespace-reference.adoc → ...pages/repository-namespace-reference.adoc
diff --git a/...sitory-populator-namespace-reference.adoc → ...sitory-populator-namespace-reference.adoc b/...sitory-populator-namespace-reference.adoc → ...sitory-populator-namespace-reference.adoc
diff --git a/...es/ROOT/pages/repository-projections.adoc → ...es/ROOT/pages/repository-projections.adoc b/...es/ROOT/pages/repository-projections.adoc → ...es/ROOT/pages/repository-projections.adoc
diff --git a/.../repository-query-keywords-reference.adoc → .../repository-query-keywords-reference.adoc b/.../repository-query-keywords-reference.adoc → .../repository-query-keywords-reference.adoc
diff --git a/...ository-query-return-types-reference.adoc → ...ository-query-return-types-reference.adoc b/...ository-query-return-types-reference.adoc → ...ository-query-return-types-reference.adoc
diff --git a/modules/ROOT/pages/upgrade.adoc → ...in/antora/modules/ROOT/pages/upgrade.adoc b/modules/ROOT/pages/upgrade.adoc → ...in/antora/modules/ROOT/pages/upgrade.adoc
diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc
@@ -3,7 +3,6 @@ Oliver Gierke; Thomas Darimont; Christoph Strobl; Mark Pollack; Thomas Risberg;
 :revnumber: {version}
 :revdate: {localdate}
 :feature-scroll: true
-ifdef::backend-epub3[:front-cover-image: image:epub-cover.png[Front Cover,1050,1600]]
 
 (C) 2008-2022 The original authors.
 

diff --git a/src/main/resources/antora-resources/antora.yml b/src/main/resources/antora-resources/antora.yml
@@ -13,4 +13,4 @@ asciidoc:
     spring-framework-javadoc: {springjavadocurl}
     releasetrainversion: 2023.0.1 # FIXME this is wrong
     store: Jpa
-    springhateoasversion: 2.2.0-SNAPSHOT
+    springhateoasversion: ${spring-hateoas}