Skip to content

Commit 57f50cb

Browse files
committed
Update README with instructions to build the project in a Docker container
1 parent e1c8998 commit 57f50cb

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.adoc

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,21 +93,42 @@ The `main` branch contains the work for the next major release `4.0.0`.
9393

9494
Building and running tests:
9595

96-
```
96+
[source,bash]
97+
----
98+
./mvnw install
99+
----
100+
101+
If you want to build the project in a Docker container, you can proceed as follows:
102+
103+
[source,bash]
104+
----
105+
docker run -it --mount type=bind,source="$(pwd)",target=/spring-shell maven:3-openjdk-17 bash
106+
cd spring-shell
107+
./mvnw install
108+
----
109+
110+
This will mount the source code that you cloned previously on the host inside the container.
111+
If you want to work on a copy of the source code inside the container (no side effects on the host),
112+
you can proceed as follows:
113+
114+
[source,bash]
115+
----
116+
docker run -it maven:3-openjdk-17 bash
117+
git clone https://github.com/spring-projects/spring-shell.git
118+
cd spring-shell
97119
./mvnw install
98-
```
120+
----
99121

100122
== Building the Documentation
101123

102124
The documentation is built using Antora and can be run using the Antora Maven plugin.
103125

104-
```
126+
[source,bash]
127+
----
105128
./mvnw antora -pl spring-shell-docs
106-
```
129+
----
107130

108131
After running the command, you can view the site for this branch in `spring-shell-docs/target/site`.
109132

110-
111-
112133
== License
113134
Spring Shell is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].

0 commit comments

Comments
 (0)