Skip to content

Commit ad91e8a

Browse files
rwinchfmbenhassine
authored andcommitted
Use Maven to Build the Docs
The rest of the project uses maven and the github workflow was attempting to use Maven.
1 parent 4f575c6 commit ad91e8a

File tree

13 files changed

+444
-355
lines changed

13 files changed

+444
-355
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@
1111
/*.iws
1212
!/.idea/checkstyle-idea.xml
1313
!/.idea/externalDependencies.xml
14+
node_modules/
15+
target/

.mvn/wrapper/maven-wrapper.jar

48.3 KB
Binary file not shown.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.8.9/apache-maven-3.8.9-bin.zip
2+

README.adoc

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,32 @@ This README covers how to build the docs in a software branch as well as how to
88

99
== Building the Site
1010

11-
You can build the entire site by invoking the following and then viewing the site at `build/site/index.html`
11+
To build the entire site invoke the following command:
1212

1313
[source,bash]
1414
----
15-
./gradlew antora
15+
./mvnw antora
1616
----
1717

18+
You will then be able to view the site at `target/site/index.html`
19+
1820
== Building a Specific Branch
1921

2022
You can build a specific branch and then viewing the branch specific site at `build/site/index.html`.
2123

2224
[source,bash]
2325
----
24-
./gradlew antora
26+
export BUILD_VERSION=4.0.0-SNAPSHOT
27+
export BUILD_REFNAME=main
28+
./mvnw antora
29+
----
30+
31+
You will then be able to see the site at `build/site/`
32+
33+
[NOTE]
34+
====
35+
If you get the following error, then you must first build the full site and publish it so that a partial builds are supported.
36+
----
37+
FATAL (antora): https://docs.spring.io/spring-shell/reference/site-manifest.json returned response code 404 (Not Found)
2538
----
39+
====

antora-playbook.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ git:
1111
ensure_git_suffix: false
1212
content:
1313
sources:
14-
- url: https://github.com/spring-projects/spring-shell
14+
- url: .
1515
# Refname matching:
1616
# https://docs.antora.org/antora/latest/playbook/content-refname-matching/
1717
branches: [ main,'({3..9}).+({0..9}).x', '!(3.0.x)', '!(3.1.x)' ]

build.gradle

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

gradle.properties

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

gradlew

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

0 commit comments

Comments
 (0)