Hg/htlle-da-vorlage
1
1
Fork 1
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

fix do-spellcheck target: use ignore.dict from sourcedir

Browse Source
This commit is contained in:
Günther Hutter 2020-04-24 10:42:17 +00:00 committed by Gitea
commit 11be45dc4b
3 changed files with 15 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Jenkinsfile vendored
View File

@ -40,8 +40,9 @@ pipeline {
} }
// sanitize git dir path // sanitize git dir path
env.GIT_PATH = params.GIT_PATH env.GIT_PATH = params.GIT_PATH
if(!env.GIT_PATH.endsWith("/")) { if(env.GIT_PATH.endsWith("/")) {
env.GIT_PATH += "/" env.GIT_PATH = env.GIT_PATH.substring(
0, (env.GIT_PATH.length() - 1))
} }
if(env.GIT_PATH.startsWith("/")) { if(env.GIT_PATH.startsWith("/")) {
env.GIT_PATH = env.GIT_PATH.substring(1) env.GIT_PATH = env.GIT_PATH.substring(1)
@ -89,14 +90,14 @@ pipeline {
stage('Checkout template') { stage('Checkout template') {
steps { steps {
// remove template folder and fresh checkout // remove template folder and fresh checkout
sh "rm -rf ${env.GIT_PATH}${env.TEMPLATE_NAME}" sh "rm -rf ${env.GIT_PATH}/${env.TEMPLATE_NAME}"
checkout([ checkout([
$class: 'GitSCM', $class: 'GitSCM',
branches: [[name: '*/master']], branches: [[name: '*/master']],
doGenerateSubmoduleConfigurations: false, doGenerateSubmoduleConfigurations: false,
extensions: [[ extensions: [[
$class: 'RelativeTargetDirectory', $class: 'RelativeTargetDirectory',
relativeTargetDir: "${env.GIT_PATH}${env.TEMPLATE_NAME}" relativeTargetDir: "${env.GIT_PATH}/${env.TEMPLATE_NAME}"
]], ]],
submoduleCfg: [], submoduleCfg: [],
userRemoteConfigs: [[ userRemoteConfigs: [[
@ -114,7 +115,7 @@ pipeline {
dir(env.GIT_PATH) { dir(env.GIT_PATH) {
sh"""#!/bin/bash sh"""#!/bin/bash
make pdf -C ${env.TEMPLATE_NAME} SOURCEDIR=`pwd` make pdf -C ${env.TEMPLATE_NAME} SOURCEDIR=`pwd`
hunspell -d de_AT,de_AT_frami,en_US -p ignore.dict -l -t *.md > diplomarbeit.pdf.spellcheck.txt make spellcheck -C ${env.TEMPLATE_NAME} SOURCEDIR=`pwd`
""" """
} }
} }
@ -141,7 +142,7 @@ pipeline {
stage('Create Tarball-Archive') { stage('Create Tarball-Archive') {
steps { steps {
dir(env.GIT_PATH) { dir(env.GIT_PATH) {
sh "tar -czvf diplomarbeit.tar.gz diplomarbeit.pdf*" sh "tar -czvf diplomarbeit.tar.gz diplomarbeit.pdf* spellcheck-results.txt"
} }
} }
} }
@ -151,7 +152,8 @@ pipeline {
script { script {
env.RECIPIENTS = "" env.RECIPIENTS = ""
// get mail addresses // get mail addresses
metadata = readFile(file: "${env.GIT_PATH}metadata.yaml").split('\n').each { line -> // needs script approval in jenkins
metadata = readFile(file: "${env.GIT_PATH}/metadata.yaml").split('\n').each { line ->
if(line.contains("- build-notification:")) { if(line.contains("- build-notification:")) {
// remove yaml comments // remove yaml comments
if(line.contains('#')) { if(line.contains('#')) {

6
Makefile
View File

@ -74,7 +74,7 @@ do-spellcheck:
@echo "Performing a spellcheck on all Markdown files" @echo "Performing a spellcheck on all Markdown files"
# Überprüft die staging Dateien auf Rechtschreibfehler # Überprüft die staging Dateien auf Rechtschreibfehler
@pandoc "$(STAGINGDIR)"/*.md -t plain | hunspell -d de_AT,de_AT_frami,en_US -p ignore.dict -l -t | sort | uniq > "$(SPELLERRORFILE)" @pandoc "$(STAGINGDIR)"/*.md -t plain | hunspell -d de_AT,de_AT_frami,en_US -p "$(STAGINGDIR)"/ignore.dict -l -t | sort | uniq > "$(SPELLERRORFILE)"
# Ausgabe der Rechtschreibfehler # Ausgabe der Rechtschreibfehler
@cat "$(SPELLERRORFILE)" | sed 's/^/ /' @cat "$(SPELLERRORFILE)" | sed 's/^/ /'
@ -95,7 +95,3 @@ pdf: build-stage compile-pdf remove-stage
# Special Targets # Special Targets
.PHONY: help pdf clean .PHONY: help pdf clean

17
README.md
View File

@ -345,9 +345,9 @@ $ tree ~/Diplomarbeit
Es muss nicht einmal die Vorlage als GIT submodule im Repository eingecheckt sein, weil hier während des Build Prozesses die aktuelle verwendet wird. Es muss nicht einmal die Vorlage als GIT submodule im Repository eingecheckt sein, weil hier während des Build Prozesses die aktuelle verwendet wird.
**Wichtig:** Sie bekommen eine `tar.gz` Datei via E-Mail zugeschickt. Dieses Archiv lässt sich mit gängigen Tools entpacken (z.B.: [7-zip](https://www.7-zip.org/)). Darin befinet sich: **Wichtig:** Sie bekommen eine `tar.gz` Datei via E-Mail zugeschickt. Dieses Archiv lässt sich mit gängigen Tools entpacken (z.B.: [7-zip](https://www.7-zip.org/)). Darin befinet sich:
- `diplomarbeit.pdf` Ihre fertige Diplomarbeit - `diplomarbeit.pdf` Ihre fertige Diplomarbeit
- `diplomarbeit.pdf.log` Der Log Output von pandoc - `diplomarbeit.pdf.log` Der Log Output von pandoc
- `diplomarbeit.pdf.spellcheck.txt` Die vermeintlich falsch geschriebenen Begriffe - `spellcheck-results.txt` Die vermeintlich falsch geschriebenen Begriffe
### Übertragen des aktuellen Standes nach GIT ### Übertragen des aktuellen Standes nach GIT
@ -450,14 +450,3 @@ Abschließend noch eine kurze Liste der wichtigsten Punkte, an denen erfahrungsg
* Quellenangaben:Zitate richtig referenziert, Seiten- oder Kapitelangaben bei gedruckten Medien * Quellenangaben:Zitate richtig referenziert, Seiten- oder Kapitelangaben bei gedruckten Medien
* Literaturverzeichnis: mehrfach zitierte Quellen nur einmal angeführt, Art der Publikation muss in jedem Fall klar sein, konsistente Einträge, Online-Quellen(URLs) sauber angeführt inkl. letztem Betrachtungszeitpunkt * Literaturverzeichnis: mehrfach zitierte Quellen nur einmal angeführt, Art der Publikation muss in jedem Fall klar sein, konsistente Einträge, Online-Quellen(URLs) sauber angeführt inkl. letztem Betrachtungszeitpunkt
* Sonstiges: ungültige Querverweise (??), Anhang, Papiergröße der PDF-Datei (A4=8.27×11.69Zoll), Druckgröße und -qualität. * Sonstiges: ungültige Querverweise (??), Anhang, Papiergröße der PDF-Datei (A4=8.27×11.69Zoll), Druckgröße und -qualität.