You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -191,19 +191,19 @@ If you remove the command line switch `--check-extern` only local links are chec
191
191
192
192
## Continuous Integration
193
193
194
-
This project contains a CI setup for Jenkins. The build uses docker to provide a stable environment for its execution. So Jenkins needs to be able to execute docker commands.
194
+
This project contains a CI setup for Jenkins. The build uses [Docker](https://www.docker.com/) to provide a stable environment for its execution. So Jenkins needs to be able to execute Docker commands.
195
195
The build process itself is defined within `Jenkinsfile` and consists of these stages:
196
196
- checkout : Get the source from repo
197
-
- build docker : Create the docker image to be used during build execution (only once if it doesn't exist locally)
198
-
- render html : render a html file from sources
199
-
- render pdf : render a pdf file from source
197
+
- build docker : Create the Docker image to be used during build execution (only once if it doesn't exist locally)
198
+
- render html : render a HTML file from sources
199
+
- render pdf : render a PDF file from source
200
200
201
-
The rendering of html, pdf,... is controlled with maven profiles (render-html, render-pdf). To enable other/ additional formats new profiles can be defined within pom.xml.
201
+
The rendering of HTML, PDF,... is controlled with Maven profiles (`render-html`, `render-pdf`). To enable other/ additional formats new profiles can be defined within `pom.xml`.
202
202
203
-
### Build without docker
203
+
### Build without Docker
204
204
205
-
If there's no docker installation available the required tools/ dependencies described abobe need to be provided on Jenkins or at least one of its agents.
206
-
-`docker/Dockerfile` can be used as template for the setup of the required tools.
205
+
If there is no Docker installation available the required tools/ dependencies described above need to be provided on Jenkins or at least one of its agents.
206
+
-[docker/Dockerfile](docker/Dockerfile) can be used as template for the setup of the required tools.
207
207
- the Jenkins agents should be labeled accordingly (i.e. pandoc)
208
208
-`Jenkinsfile` : label needs to match agent-labels (i.e. pandoc)
209
209
-`Jenkinsfile` : the "build docker" stage has to be removed
0 commit comments