Skip to content

Commit 32e0a05

Browse files
rwinchgregturn
rwinch
authored and
gregturn
committed
Use antora-maven-plugin.
Changes for docs-build and sources using antora-maven-plugin See #3095
1 parent b53f251 commit 32e0a05

File tree

3 files changed

+23
-92
lines changed

3 files changed

+23
-92
lines changed

‎.github/workflows/deploy-docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ jobs:
3636
echo BUILD_VERSION=$BUILD_VERSION >> $GITHUB_ENV
3737
- name: Run Antora
3838
run: |
39-
./mvnw compile
39+
./mvnw antora
4040
- name: Publish Docs
4141
uses: spring-io/spring-doc-actions/[email protected]
4242
with:
4343
docs-username: ${{ secrets.DOCS_USERNAME }}
4444
docs-host: ${{ secrets.DOCS_HOST }}
4545
docs-ssh-key: ${{ secrets.DOCS_SSH_KEY }}
4646
docs-ssh-host-key: ${{ secrets.DOCS_SSH_HOST_KEY }}
47-
site-path: target/site
47+
site-path: spring-data-jpa/target/antora/site
4848
- name: Bust Cloudflare Cache
4949
uses: spring-io/spring-doc-actions/[email protected]
5050
with:

‎antora-playbook.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
antora:
22
extensions:
33
- '@springio/antora-extensions/partial-build-extension'
4+
- require: '@springio/antora-extensions/latest-version-extension'
45
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
56
- '@antora/collector-extension'
67
- '@antora/atlas-extension'
@@ -15,8 +16,11 @@ git:
1516
content:
1617
sources:
1718
- url: https://github.com/spring-projects/spring-data-jpa
18-
branches: [main]
19-
start_path: src/main/antora
19+
# Refname matching:
20+
# https://docs.antora.org/antora/latest/playbook/content-refname-matching/
21+
branches: [ main,'({3..9}).+({0..9}).x', '!(3.{0..1}.x)' ]
22+
tags: [ '({3..9}).+({0..9}).+({0..9})?(-{RC,M}+({0..9}))', '!(3.{0..1}.+({0..9})?(-{RC,M}+({0..9})))','!(3.2.0-M1)','!(3.2.0-M2)' ]
23+
start_path: spring-data-jpa/src/main/antora
2024
asciidoc:
2125
attributes:
2226
page-stackoverflow-url: https://stackoverflow.com/tags/spring-data-jpa

‎pom.xml

Lines changed: 15 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -27,103 +27,30 @@
2727
<scala>2.11.7</scala>
2828
<xmlbeam>1.4.24</xmlbeam>
2929
<java-module-name>spring.data.jpa</java-module-name>
30-
31-
<!-- Antora -->
32-
<node.version>v18.12.1</node.version>
33-
<npm.version>8.19.2</npm.version>
34-
<antora.version>3.2.0-alpha.2</antora.version>
35-
<antora-atlas.version>1.0.0-alpha.1</antora-atlas.version>
36-
<antora-collector.version>1.0.0-alpha.3</antora-collector.version>
37-
<asciidoctor-tabs.version>1.0.0-beta.3</asciidoctor-tabs.version>
38-
<spring-antora-extensions.version>1.5.0</spring-antora-extensions.version>
39-
<spring-asciidoctor-extensions.version>1.0.0-alpha.9</spring-asciidoctor-extensions.version>
40-
30+
<io.spring.maven.antora-version>0.0.3</io.spring.maven.antora-version>
4131
</properties>
4232

4333

4434
<build>
4535
<plugins>
4636
<plugin>
47-
<groupId>com.github.eirslett</groupId>
48-
<artifactId>frontend-maven-plugin</artifactId>
49-
<version>1.12.1</version>
50-
<executions>
51-
<execution>
52-
<id>install node and npm</id>
53-
<goals>
54-
<goal>install-node-and-npm</goal>
55-
</goals>
56-
<phase>initialize</phase>
57-
<configuration>
58-
<nodeVersion>${node.version}</nodeVersion>
59-
<npmVersion>${npm.version}</npmVersion>
60-
</configuration>
61-
</execution>
62-
<execution>
63-
<id>npm install antora</id>
64-
<goals>
65-
<goal>npm</goal>
66-
</goals>
67-
<phase>initialize</phase>
68-
<configuration>
69-
<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>
70-
</configuration>
71-
</execution>
72-
</executions>
73-
</plugin>
74-
<plugin>
75-
<groupId>org.codehaus.mojo</groupId>
76-
<artifactId>exec-maven-plugin</artifactId>
77-
<version>3.0.0</version>
78-
<executions>
79-
<execution>
80-
<id>antora</id>
81-
<goals>
82-
<goal>exec</goal>
83-
</goals>
84-
<phase>compile</phase>
85-
<configuration>
86-
<environmentVariables>
87-
<ALGOLIA_API_KEY>9d489079e5ec46dbb238909fee5c9c29</ALGOLIA_API_KEY>
88-
<ALGOLIA_APP_ID>WB1FQYI187</ALGOLIA_APP_ID>
89-
<ALGOLIA_INDEX_NAME>springdatajpa</ALGOLIA_INDEX_NAME>
90-
</environmentVariables>
91-
<!-- If we don't want to depend on default node installation path we can use a maven
92-
property aligned with frontend-maven-plugin's installDirectory configuration -->
93-
<executable>node/node</executable>
94-
<arguments>
95-
<argument>node_modules/.bin/antora</argument>
96-
<argument>antora-playbook.yml</argument>
97-
<argument>--to-dir=target/site</argument>
98-
<argument>--stacktrace</argument>
99-
</arguments>
100-
<workingDirectory>${project.basedir}</workingDirectory>
101-
</configuration>
102-
</execution>
103-
</executions>
104-
</plugin>
105-
<plugin>
106-
<groupId>org.apache.maven.plugins</groupId>
107-
<artifactId>maven-clean-plugin</artifactId>
108-
<version>3.1.0</version>
37+
<groupId>io.spring.maven.antora</groupId>
38+
<artifactId>antora-maven-plugin</artifactId>
39+
<version>${io.spring.maven.antora-version}</version>
40+
<extensions>true</extensions>
10941
<configuration>
110-
<filesets>
111-
<fileset>
112-
<directory>node</directory>
113-
<followSymlinks>false</followSymlinks>
114-
</fileset>
115-
<fileset>
116-
<directory>node_modules</directory>
117-
<followSymlinks>false</followSymlinks>
118-
</fileset>
119-
<fileset>
120-
<directory>build</directory>
121-
<followSymlinks>false</followSymlinks>
122-
</fileset>
123-
</filesets>
42+
<options>
43+
<option>--to-dir=target/antora/site</option>
44+
<option>--stacktrace</option>
45+
<option>--fetch</option>
46+
</options>
47+
<environment>
48+
<ALGOLIA_API_KEY>9d489079e5ec46dbb238909fee5c9c29</ALGOLIA_API_KEY>
49+
<ALGOLIA_APP_ID>WB1FQYI187</ALGOLIA_APP_ID>
50+
<ALGOLIA_INDEX_NAME>springdatajpa</ALGOLIA_INDEX_NAME>
51+
</environment>
12452
</configuration>
12553
</plugin>
126-
12754
</plugins>
12855
</build>
12956

0 commit comments

Comments
 (0)