From 3c5b83d750cbaa1f152f6d3984c4fc448c4044bf Mon Sep 17 00:00:00 2001
From: Martin Hierholzer <martin.hierholzer@desy.de>
Date: Mon, 3 Dec 2018 15:57:31 +0100
Subject: [PATCH] Update README.md
---
README.md | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 9b51d03..e609936 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,10 @@ Shared libraries for Jenkins CI tests of ChimeraTK libraries and DESY MSK projec
Usage:
- Create a pipline job on Jenkins with the following pipeline script:
- @Library('ChimeraTK') _
- buildTestDeploy(['dependency1', 'dependency2'], 'https://path/to/git/repository')
+```
+@Library('ChimeraTK') _
+buildTestDeploy(['dependency1', 'dependency2'], 'https://path/to/git/repository')
+```
- Beware the underscore at the end of the first line!
- The list of dependencies can be empty, if there are no dependencies
- The dependencies specify the Jenkins project names of which the artefacts should be obtained and unpacked into
@@ -14,8 +16,10 @@ Shared libraries for Jenkins CI tests of ChimeraTK libraries and DESY MSK projec
- Create a second pipeline job on Jenkins with the name of the main job appended by '-analysis' (e.g. 'ChimeraTK-DeviceAccess-analysis' if the first job is called 'ChimeraTK-DeviceAccess').
- Put in the following pipeline script:
- @Library('ChimeraTK') _
- analysis()
+```
+@Library('ChimeraTK') _
+analysis()
+```
- Execute this job once after the main job is finished for the first time, to also fill in the project triggers etc. for the analysis job.
--
GitLab