forked from Hg/htlle-da-vorlage
add jenkinsn job information
This commit is contained in:
parent
be7b2c48d4
commit
662a6f8071
124
README.md
124
README.md
@ -22,6 +22,8 @@ Wenn Sie Änderungen an diesem Template wünschen, dann erstellen Sie bitte ein
|
|||||||
|
|
||||||
Damit die DA gebaut werden kann müssen mehrere Programme installiert sein. Theoretisch funktioniert das auch mit 'purem' Windows, aber einfacher ist es die Arbeit mit Hilfe von Linux zu erstellen. Aus diesem Grund finden Sie hier nur die Anweisungen die sich auf einem **Ubuntu 18.04 LTS** beziehen.
|
Damit die DA gebaut werden kann müssen mehrere Programme installiert sein. Theoretisch funktioniert das auch mit 'purem' Windows, aber einfacher ist es die Arbeit mit Hilfe von Linux zu erstellen. Aus diesem Grund finden Sie hier nur die Anweisungen die sich auf einem **Ubuntu 18.04 LTS** beziehen.
|
||||||
|
|
||||||
|
Wenn der HTL eigene GIT-Server verwendet wird, brauchen Sie die Tools nicht unbedingt installieren und Sie können sich die Arbeit als PDF per E-Mail zuschicken lassen. Mehr dazu weiter [unten](#Remote)
|
||||||
|
|
||||||
## Windows
|
## Windows
|
||||||
|
|
||||||
Wenn man Windows 10 als primäres Betriebssystem verwendet hat man zwei Möglichkeiten um zu einer Linux Umgebung zu kommen:
|
Wenn man Windows 10 als primäres Betriebssystem verwendet hat man zwei Möglichkeiten um zu einer Linux Umgebung zu kommen:
|
||||||
@ -93,7 +95,7 @@ Wenn Sie ein lokales Repo haben, dann wird dieses Repository als [git-submodule]
|
|||||||
~/Diplomarbeit$ git submodule add https://itsp.htl-leoben.at/git/Hg/HTLLE-DA-Vorlage.git
|
~/Diplomarbeit$ git submodule add https://itsp.htl-leoben.at/git/Hg/HTLLE-DA-Vorlage.git
|
||||||
```
|
```
|
||||||
|
|
||||||
Der erste Befehl verhindert dass Änderungen an Berechtigungen (wie sie WSL im Hintegrund durchführt) dazu führen dass die Datei als modifiziert angesehen wird. Der zweite Befehl holt das Submodul dazu.
|
Der erste Befehl verhindert dass Änderungen an Berechtigungen (wie sie WSL im Hintergrund durchführt) dazu führen dass die Datei als modifiziert angesehen wird. Der zweite Befehl holt das Submodul dazu.
|
||||||
|
|
||||||
Falls das Template durch hg geändert wird können Sie mit Hilfe des Befehls `git submodule update --remote` ihre derzeitige Version durch die jeweils aktuellste Version des Templates ersetzen. Damit die Änderungen sichtbar werden müssen Sie natürlich die Diplomarbeit vorher neu bauen.
|
Falls das Template durch hg geändert wird können Sie mit Hilfe des Befehls `git submodule update --remote` ihre derzeitige Version durch die jeweils aktuellste Version des Templates ersetzen. Damit die Änderungen sichtbar werden müssen Sie natürlich die Diplomarbeit vorher neu bauen.
|
||||||
|
|
||||||
@ -223,6 +225,10 @@ da-appendix:
|
|||||||
|
|
||||||
- abschnitt: Diplomatbeitsvereinbarung
|
- abschnitt: Diplomatbeitsvereinbarung
|
||||||
pdf-file: HTL-DA-Vereinbarung.pdf
|
pdf-file: HTL-DA-Vereinbarung.pdf
|
||||||
|
|
||||||
|
da-build-properties:
|
||||||
|
- build-notification: Diplomarbeit - DA_2021_Thema <269bc6a5.O365.htl-leoben.at@emea.teams.ms>
|
||||||
|
- build-notification: mytesms@adress.com
|
||||||
---
|
---
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -238,20 +244,132 @@ Um das Zusammensuchen der Quellenangaben für Bücher zu vereinfachen kann man i
|
|||||||
|
|
||||||
### Bauen der Diplomarbeit als PDF Datei
|
### Bauen der Diplomarbeit als PDF Datei
|
||||||
|
|
||||||
|
#### Lokal
|
||||||
Damit das PDF für die Diplomarbeit erstellt wird muss (aus Ihrem Basisverzeichnis heraus) folgender Befehl abgesetzt werden:
|
Damit das PDF für die Diplomarbeit erstellt wird muss (aus Ihrem Basisverzeichnis heraus) folgender Befehl abgesetzt werden:
|
||||||
|
|
||||||
```
|
```
|
||||||
make pdf -C HTLLE-DA-Vorlage SOURCEDIR=$(pwd)
|
make pdf -C HTLLE-DA-Vorlage SOURCEDIR=$(pwd)
|
||||||
```
|
```
|
||||||
|
|
||||||
Danach erscheint (sofern alles gut geht) die Datei `HTLLE-DA-Vorlage/output/diplomarbeit.pdf`. Sollte die Datei bereits von einem früheren Lauf her existiert haben wird sie einfach überschrieben. Sollte die Arbeit nicht erfolgreich gebaut werden können, dann kann in der Datei `pandoc.log` der Grund dafür heruasgefunden werden.
|
Danach erscheint (sofern alles gut geht) die Datei `HTLLE-DA-Vorlage/output/diplomarbeit.pdf`. Sollte die Datei bereits von einem früheren Lauf her existiert haben wird sie einfach überschrieben. Sollte die Arbeit nicht erfolgreich gebaut werden können, dann kann in der Datei `pandoc.log` der Grund dafür herausgefunden werden.
|
||||||
|
|
||||||
Damit Sie nicht immer den gesamten Befehl schreiben müssen können Sie sich auch einen Alias setzen:
|
Damit Sie nicht immer den gesamten Befehl schreiben müssen können Sie sich auch einen Alias setzen:
|
||||||
|
|
||||||
```
|
```
|
||||||
alias da="make pdf -C HTLLE-DA-Vorlage SOURCEDIR=$(pwd)"
|
alias da="make pdf -C HTLLE-DA-Vorlage SOURCEDIR=$(pwd)"
|
||||||
```
|
```
|
||||||
Damit beschränkt sich Ihre eigentliche Arbeit darauf, die Markdoen Files zu editieren (nicht veressen zu speichern) und anschließend den neuen Alias `da` aufzurufen. Danach haben Sie immer die neuste Diplomarbeit gebaut.
|
Damit beschränkt sich Ihre eigentliche Arbeit darauf, die Markdown Files zu editieren (nicht veressen zu speichern) und anschließend den neuen Alias `da` aufzurufen. Danach haben Sie immer die neuste Diplomarbeit gebaut.
|
||||||
|
|
||||||
|
#### Remote
|
||||||
|
Sollten Sie die notwendigen Tools (pandoc, LaTeX, etc.) nicht lokal installieren wollen und Sie haben Ihre Diplomarbeit am GIT-Server der HTL versioniert, dann können Sie Ihre PDF auch am [Jenkins](https://itsp.htl-leoben.at/ci) bauen und sich per E-Mail zuschicken lassen. Es wird dabei immer das aktuelle Template verwendet.
|
||||||
|
|
||||||
|
Ö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.
|
||||||
|
|
||||||
|
Beispiel: `GIT_PATH` ist `"text"`
|
||||||
|
```
|
||||||
|
$ tree ~/Diplomarbeit
|
||||||
|
.
|
||||||
|
├── source
|
||||||
|
└── text
|
||||||
|
├── 10-einleitung.md
|
||||||
|
├── 20-zielsetzung.md
|
||||||
|
├── 30-ausarbeitungen.md
|
||||||
|
├── 31-ausarbeitung_schueler1.md
|
||||||
|
├── 32-ausarbeitung_schueler2.md
|
||||||
|
├── 40-zusammenfassung.md
|
||||||
|
├── HTLLE-DA-Vorlage
|
||||||
|
│ ├── Jenkinsfile
|
||||||
|
│ ├── LICENSE
|
||||||
|
│ ├── Makefile
|
||||||
|
│ ├── README.md
|
||||||
|
│ ├── example
|
||||||
|
│ │ ├── 10-einleitung.md
|
||||||
|
│ │ ├── 20-zielsetzung.md
|
||||||
|
│ │ ├── 30-ausarbeitungen.md
|
||||||
|
│ │ ├── 31-ausarbeitung_schueler1.md
|
||||||
|
│ │ ├── 32-ausarbeitung_schueler2.md
|
||||||
|
│ │ ├── 40-zusammenfassung.md
|
||||||
|
│ │ ├── img
|
||||||
|
│ │ │ └── graph.png
|
||||||
|
│ │ ├── literatur.bib
|
||||||
|
│ │ ├── metadata.yaml
|
||||||
|
│ │ └── pdfs
|
||||||
|
│ │ ├── HTL-DA-Vereinbarung.pdf
|
||||||
|
│ │ ├── README
|
||||||
|
│ │ ├── begleitprotokolle.pdf
|
||||||
|
│ │ ├── pandoc-manual.pdf
|
||||||
|
│ │ └── projekthandbuch.pdf
|
||||||
|
│ └── style
|
||||||
|
│ ├── HTLLE-Logo.png
|
||||||
|
│ ├── deutsche-gesellschaft-fur-psychologie.csl
|
||||||
|
│ ├── template.tex
|
||||||
|
│ ├── updated-deutsche-gesellschaft-fur-psychologie.csl
|
||||||
|
│ └── verzeichnisse.md
|
||||||
|
├── img
|
||||||
|
│ └── graph.png
|
||||||
|
├── literatur.bib
|
||||||
|
├── metadata.yaml
|
||||||
|
└── pdfs
|
||||||
|
├── HTL-DA-Vereinbarung.pdf
|
||||||
|
├── README
|
||||||
|
├── begleitprotokolle.pdf
|
||||||
|
├── pandoc-manual.pdf
|
||||||
|
└── projekthandbuch.pdf
|
||||||
|
```
|
||||||
|
|
||||||
|
Beispiel: `GIT_PATH` ist default `"./"`
|
||||||
|
```
|
||||||
|
$ tree ~/Diplomarbeit
|
||||||
|
.
|
||||||
|
├── 10-einleitung.md
|
||||||
|
├── 20-zielsetzung.md
|
||||||
|
├── 30-ausarbeitungen.md
|
||||||
|
├── 31-ausarbeitung_schueler1.md
|
||||||
|
├── 32-ausarbeitung_schueler2.md
|
||||||
|
├── 40-zusammenfassung.md
|
||||||
|
├── HTLLE-DA-Vorlage
|
||||||
|
│ ├── Jenkinsfile
|
||||||
|
│ ├── LICENSE
|
||||||
|
│ ├── Makefile
|
||||||
|
│ ├── README.md
|
||||||
|
│ ├── example
|
||||||
|
│ │ ├── 10-einleitung.md
|
||||||
|
│ │ ├── 20-zielsetzung.md
|
||||||
|
│ │ ├── 30-ausarbeitungen.md
|
||||||
|
│ │ ├── 31-ausarbeitung_schueler1.md
|
||||||
|
│ │ ├── 32-ausarbeitung_schueler2.md
|
||||||
|
│ │ ├── 40-zusammenfassung.md
|
||||||
|
│ │ ├── img
|
||||||
|
│ │ │ └── graph.png
|
||||||
|
│ │ ├── literatur.bib
|
||||||
|
│ │ ├── metadata.yaml
|
||||||
|
│ │ └── pdfs
|
||||||
|
│ │ ├── HTL-DA-Vereinbarung.pdf
|
||||||
|
│ │ ├── README
|
||||||
|
│ │ ├── begleitprotokolle.pdf
|
||||||
|
│ │ ├── pandoc-manual.pdf
|
||||||
|
│ │ └── projekthandbuch.pdf
|
||||||
|
│ └── style
|
||||||
|
│ ├── HTLLE-Logo.png
|
||||||
|
│ ├── deutsche-gesellschaft-fur-psychologie.csl
|
||||||
|
│ ├── template.tex
|
||||||
|
│ ├── updated-deutsche-gesellschaft-fur-psychologie.csl
|
||||||
|
│ └── verzeichnisse.md
|
||||||
|
├── img
|
||||||
|
│ └── graph.png
|
||||||
|
├── literatur.bib
|
||||||
|
├── metadata.yaml
|
||||||
|
└── pdfs
|
||||||
|
├── HTL-DA-Vereinbarung.pdf
|
||||||
|
├── README
|
||||||
|
├── begleitprotokolle.pdf
|
||||||
|
├── pandoc-manual.pdf
|
||||||
|
└── projekthandbuch.pdf
|
||||||
|
```
|
||||||
|
|
||||||
|
**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](#metadata.yaml).
|
||||||
|
|
||||||
### Übertragen des aktuellen Standes nach GIT
|
### Übertragen des aktuellen Standes nach GIT
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user