Skip to content

Commit 351ad05

Browse files
rwinchfmbenhassine
rwinch
authored and
fmbenhassine
committed
Use the antora-component-version-maven-plugin and its instructions See
https://github.com/spring-io/spring-antora-maven-plugins?tab=readme-ov-file#antora-component-version-maven-plugin
1 parent 2e37af3 commit 351ad05

File tree

8 files changed

+101
-46
lines changed

8 files changed

+101
-46
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ build/
77
bin/
88
.jfrog/
99

10+
node_modules/
11+
1012
.gradle
1113
.idea/
1214
*.iml

‎README.adoc‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,5 +97,17 @@ Building and running tests:
9797
./mvnw install
9898
```
9999

100+
== Building the Documentation
101+
102+
The documentation is built using Antora and can be run using the Antora Maven plugin.
103+
104+
```
105+
./mvnw antora -pl spring-shell-docs
106+
```
107+
108+
After running the command, you can view the site for this branch in `spring-shell-docs/target/site`.
109+
110+
111+
100112
== License
101113
Spring Shell is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].

‎spring-shell-docs/antora-playbook.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
antora:
2+
extensions:
3+
- require: '@springio/antora-extensions'
4+
root_component_name: 'shell'
5+
- require: '@springio/antora-extensions/asciinema-extension'
6+
site:
7+
title: Spring Shell
8+
url: https://docs.spring.io/spring-shell/reference
9+
robots: allow
10+
git:
11+
ensure_git_suffix: false
12+
content:
13+
sources:
14+
- url: ..
15+
# Refname matching:
16+
# https://docs.antora.org/antora/latest/playbook/content-refname-matching/
17+
branches: [ main,'({3..9}).+({0..9}).x', '!(3.0.x)', '!(3.1.x)' ]
18+
tags: [ 'v({3..9}).+({0..9}).+({0..19})?(-{RC,M}+({0..9}))', '!(v3.0.+({0..9})?(-{RC,M}+({0..9})))', '!(v3.1.0-{RC,M}+({0..9}))', '!(v3.1.({0..19}))' ]
19+
start_path: spring-shell-docs
20+
asciidoc:
21+
attributes:
22+
page-stackoverflow-url: https://stackoverflow.com/tags/spring-shell
23+
page-pagination: ''
24+
hide-uri-scheme: '@'
25+
tabs-sync-option: '@'
26+
extensions:
27+
- '@asciidoctor/tabs'
28+
- '@springio/asciidoctor-extensions'
29+
- '@springio/asciidoctor-extensions/javadoc-extension'
30+
urls:
31+
latest_version_segment_strategy: redirect:to
32+
latest_version_segment: ''
33+
redirect_facility: httpd
34+
ui:
35+
bundle:
36+
url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip
37+
snapshot: true
38+
runtime:
39+
log:
40+
failure_level: warn

‎spring-shell-docs/antora.yml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
name: shell
2-
version: 4.0.0-SNAPSHOT
2+
version: true
33
title: Spring Shell
44
nav:
55
- modules/ROOT/nav.adoc
6+
ext:
7+
collector:
8+
run:
9+
command: mvnw process-resources -pl spring-shell-docs
10+
local: true
11+
scan:
12+
dir: ./target/classes/antora-resources

‎spring-shell-docs/package.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"dependencies": {
3+
"antora": "3.2.0-alpha.9",
4+
"@antora/atlas-extension": "1.0.0-alpha.5",
5+
"@antora/collector-extension": "1.0.2",
6+
"@asciidoctor/tabs": "1.0.0-beta.6",
7+
"@springio/antora-extensions": "1.14.7",
8+
"@springio/asciidoctor-extensions": "1.0.0-alpha.17"
9+
}
10+
}

‎spring-shell-docs/pom.xml‎

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -45,33 +45,30 @@
4545
</dependencies>
4646

4747
<build>
48-
<resources>
49-
<resource>
50-
<directory>src/main/antora</directory>
51-
<filtering>true</filtering>
52-
<includes>
53-
<include>antora-playbook.yml</include>
54-
</includes>
55-
</resource>
56-
</resources>
5748
<plugins>
5849
<plugin>
5950
<groupId>org.antora</groupId>
6051
<artifactId>antora-maven-plugin</artifactId>
61-
<version>${antora-maven-plugin.version}</version>
52+
<version>1.0.0-alpha.5</version>
6253
<extensions>true</extensions>
6354
<configuration>
64-
<nodeVersion>${nodejs.version}</nodeVersion>
65-
<playbookFile>target/classes/antora-playbook.yml</playbookFile>
55+
<environmentVariables>
56+
<BUILD_REFNAME>HEAD</BUILD_REFNAME>
57+
<BUILD_VERSION>${project.version}</BUILD_VERSION>
58+
</environmentVariables>
6659
</configuration>
6760
</plugin>
6861
<plugin>
69-
<groupId>org.apache.maven.plugins</groupId>
70-
<artifactId>maven-deploy-plugin</artifactId>
71-
<version>${maven-deploy-plugin.version}</version>
72-
<configuration>
73-
<skip>true</skip>
74-
</configuration>
62+
<groupId>io.spring.maven.antora</groupId>
63+
<artifactId>antora-component-version-maven-plugin</artifactId>
64+
<version>0.0.4</version>
65+
<executions>
66+
<execution>
67+
<goals>
68+
<goal>antora-component-version</goal>
69+
</goals>
70+
</execution>
71+
</executions>
7572
</plugin>
7673
</plugins>
7774
</build>

‎spring-shell-docs/src/main/antora/antora-playbook.yml‎

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

‎spring-shell-docs/src/main/antora/resources/antora-resources/antora.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: ${antora-component.version}
2+
prerelease: ${antora-component.prerelease}
3+
4+
asciidoc:
5+
attributes:
6+
page-stackoverflow-url: https://stackoverflow.com/tags/spring-shell
7+
page-pagination: ''
8+
hide-uri-scheme: '@'
9+
tabs-sync-option: '@'
10+
chomp: 'all'
11+
attribute-missing: 'warn'
12+
snippets: example$docs-src/test/java/org/springframework/shell/docs
13+
project-version: ${project.parent.version}
14+
sourcemap: true

0 commit comments

Comments
 (0)