From 1f7907f0d220b2b9a00a1d2a42d71a8ae95e0bf9 Mon Sep 17 00:00:00 2001 From: Clemens Lauermann Date: Sun, 19 Apr 2020 18:50:53 +0200 Subject: [PATCH] add branch option to build job --- Jenkinsfile | 13 ++++++++++--- README.md | 6 ++++-- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 0ff7210..ecc4bfa 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -11,12 +11,17 @@ pipeline { name: 'REPOSITORY', defaultValue: 'itsp.htl-leoben.at/git/Hg/HTLLE-DA-Vorlage.git', description: 'URL git-Repository DA//' - ) + ) string( name: 'GIT_PATH', defaultValue: './', description: "Pfad zur DA in git (z.B.: dipl/)" - ) + ) + string( + name: 'GIT_BRANCH', + defaultValue: '*/master', + description: "Expert: Wenn Sie einen anderen als den 'master' Branch bauen möchten" + ) } stages { @@ -40,12 +45,14 @@ pipeline { if(env.GIT_PATH.startsWith("~/")) { env.GIT_PATH = env.GIT_PATH.substring(2, (env.GIT_PATH.length() - 1)) } + // be sure branch is set + env.GIT_BRANCH = params.GIT_BRANCH ?: '*/master' } // checkout out the repository including submodules // builduser acc used in git checkout([ $class: 'GitSCM', - branches: [[name: '*/master']], + branches: [[name: "${env.GIT_BRANCH}"]], doGenerateSubmoduleConfigurations: false, extensions: [[ $class: 'SubmoduleOption', diff --git a/README.md b/README.md index 2107d79..3d332aa 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ Wenn Sie mit einer neuen Diplomarbeit beginnen, dann gehen Sie am besten wie fol ### Erstellen eines leeren GIT Repositories in dem Sie Ihre DA Daten verwalten werden. -Es ist prinzipiell egal auf welchem GIT Server sie Ihr Repository hosten. Wir empfehlen dies aber auf dem HTL eigenen `https://itsp.htl-leoben.at/git` Server zu machen. **Sollten Sie Ihre Arbeit auf einem anderen Server hosten, dann achten Sie darauf dass sie ein privates Repository verwenden** denn sonst wäre der Inhalt der Arbeit bereits (unabsichtlich) veröffentlicht und beim Plagiatscheck würde Ihre gesamte Arbeit als Plagiat aufscheinen - und in weiterer Folge dann abgelehnt werden. +Es ist prinzipiell egal auf welchem GIT Server sie Ihr Repository hosten. Wir empfehlen dies aber auf dem HTL eigenen `https://itsp.htl-leoben.at/git` Server zu machen. **Sollten Sie Ihre Arbeit auf einem anderen Server hosten, dann achten Sie darauf dass sie ein privates Repository verwenden** denn sonst wäre der Inhalt der Arbeit bereits (unabsichtlich) veröffentlicht und beim Plagiatscheck würde Ihre gesamte Arbeit als Plagiat aufscheinen - und in weiterer Folge dann abgelehnt werden. Auch am HTL eigenen GIT-Server kann es aus Plagiats-Gründen ratsam sein, für die Diplomarbeit ein privates Repository zu verwenden. #### Fall 1: Sie beginnen mit einem komplett neuen Repository @@ -265,7 +265,7 @@ Sollten Sie die notwendigen Tools (pandoc, LaTeX, etc.) nicht lokal installieren Öffnen Sie dazu den [Jenkins-Job](https://itsp.htl-leoben.at/ci/job/HTLLE-Diplomarbeit/build?delay=0sec) und melden Sie sich ggf. mit Ihren Benutzerdaten (z.B.: `1911wit00`) an. -Für `REPOSITORY` tragen Sie bitte Ihre Repository-URL (z.B: `https://itsp.htl-leoben.at/git/1911wit00/Diplomarbeit.git`) und für `GIT_PATH` ggf. den Unterordner, in dem sich Ihre Diplomarbeit auf GIT befindet (z.B.: `diplomarbeit/`), ein. +Für `REPOSITORY` tragen Sie bitte Ihre Repository-URL (z.B: `https://itsp.htl-leoben.at/git/1911wit00/Diplomarbeit.git`) und für `GIT_PATH` ggf. den Unterordner, in dem sich Ihre Diplomarbeit auf GIT befindet (z.B.: `diplomarbeit/`), ein. Wenn Sie nicht wissen was in GIT `branches` sind, brauchen Sie den Parameter `GIT_BRANCH` nicht anpassen. Beispiel: `GIT_PATH` ist `"text"` ``` @@ -321,6 +321,8 @@ $ tree ~/Diplomarbeit **Wichtig:** Das fertige PDF wird an die E-Mail Adressen aus `metadata.yaml` verschickt! Die E-Mail Adressen müssen mit `"- build-notification"` gekennzeichnet sein ([siehe oben](#befüllen-der-speziellen-dateien)). +Das Submodule der Vorlage muss mit dem Namen `HTLLE-DA-Vorlage` hinzugefügt sein (siehe `tree` Ansicht von oben). + ### Übertragen des aktuellen Standes nach GIT Es mach Sinn, die Diplomarbeit (auch nach kleinen Änderungen) immer wieder nach GIT zu übertragen. Damit ist sie optimal gesichert und falls Ihre Teammitglieder auch an der DA Arbeiten bekommen sie auch Zugang zum aktuellsten Stand. Falls Sie noch nicht mit GIT gearbeitet haben, stellen die folgenden Absätze eine (ultra-) [Kurzeinführung](https://rogerdudler.github.io/git-guide/) dar.