Skip to content

Commit 775ac2c

Browse files
author
Klaus Wening
committed
Updated Pull-Request
1 parent 5349919 commit 775ac2c

File tree

3 files changed

+256
-254
lines changed

3 files changed

+256
-254
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -191,19 +191,19 @@ If you remove the command line switch `--check-extern` only local links are chec
191191

192192
## Continuous Integration
193193

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.
195195
The build process itself is defined within `Jenkinsfile` and consists of these stages:
196196
- 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
200200

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`.
202202

203-
### Build without docker
203+
### Build without Docker
204204

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.
207207
- the Jenkins agents should be labeled accordingly (i.e. pandoc)
208208
- `Jenkinsfile` : label needs to match agent-labels (i.e. pandoc)
209209
- `Jenkinsfile` : the "build docker" stage has to be removed

docker/Dockerfile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
FROM maven:3.5-jdk-8
22

3+
ARG PANDOC_VERSION="2.2.3.2"
4+
35
# Install dependencies texlive, graphviz
46
RUN apt-get update \
57
&& apt-get install -y texlive-latex-base graphviz \
@@ -8,7 +10,7 @@ RUN apt-get update \
810
&& apt-get clean
911

1012
# pandoc 2.x required
11-
RUN curl -fL https://github.com/jgm/pandoc/releases/download/2.2.3.2/pandoc-2.2.3.2-linux.tar.gz | tar xzv --strip-components 1 -C /usr/local/
13+
RUN curl -fL https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-linux.tar.gz | tar xzv --strip-components 1 -C /usr/local/
1214

1315
RUN apt-get install -y texlive-fonts-recommended librsvg2-bin
1416

0 commit comments

Comments
 (0)