Österreichischer e-Health-Terminologie-Browser
2.8.0+20240725 - TerminoloGit

Setup (de)

For the english version please click here.

Quickstart

Bitte lesen Sie den Quickstart, um Ihr eigenes TerminoloGit einzurichten.

TerminoloGit zurücksetzen

Wenn Sie mit TerminoloGit neu anfangen wollen, ist es ratsam, alle terminologiebezogenen Informationen aus dem geforketen Projekt zu löschen.

Lesen Sie die Beschreibung über das Löschen einer Terminologie, um Ihren TerminoloGit Fork zurückzusetzen.

Landing Page hinzufügen

TerminoloGit erwartet die folgenden Dateien:

  • input/pagecontent/index.html
  • input/pagecontent/index_en.html

Die primäre Sprache ist de, daher sollte index.html die deutsche Version der Landing Page enthalten. Auf der anderen Seite sollte index_en.html die englische Version der Landing Page enthalten.

Falls eine oder beide Dateien nicht angegeben werden, enthalten sie automatisch den Inhalt von technical_documentation_de.html und technical_documentation_en.html.

CI/CD-Variablen

In der folgenden Tabelle sind alle CI/CD-Variablen aufgeführt, die zur Konfiguration der Funktionalität von TerminoloGit verwendet werden können. Abgesehen von den Spalten Beschreibung und Erforderlich stellen die Spalten die Felder dar, die bei der Erstellung einer CI/CD-Variable in GitLab ausgefüllt werden müssen.

SchlüsselBeschreibungErforderlichWert (Beispiel)TypUmgebungVariable schützenVariable maskierenVariablenreferenz erweitern
[username]_GITLAB_CI_TOKEN

Verwenden Sie Ihren GitLab.com-Benutzernamen als Teil des Namens der CI/CD-Variable.
Ermöglicht es, bestimmte in den Pipelines erstellte Ergebnisse in das Repository zu pushen.jaErstellen Sie einen persönlichen Zugriffstoken mit den Geltungsbereichen api und read_userVariableAlleneinjanein
RUNNER_TAGGibt an, welcher SaaS-Runner von GitLab.com von den Pipeline-Aufträgen verwendet werden soll.jaAbhängig von Ihrem GitLab.com-Abo können Sie zwischen den folgenden SaaS-Runner auf Linux wählen, z.B. saas-linux-medium-amd64.VariableAlleneinneinnein
RUNNER_TAG_FOR_IG_RUNWird nur für den run_ig Job verwendet. Gibt an, welcher SaaS-Runner von GitLab.com von den Pipeline-Aufträgen verwendet werden soll.jaAbhängig von Ihrem GitLab.com-Abo können Sie zwischen den folgenden SaaS-Runner auf Linux wählen, z.B. saas-linux-medium-amd64.VariableAlleneinneinnein
TERMGIT_CANONICALGibt die kanonische URL für das erstellte FHIR® IG an und wird als Basis-URL für diejenigen Terminologien verwendet, die noch keine eigene kanonische URL angegeben haben.jahttps://[username].gitlab.io/termgit-devVariableAlleneinneinnein
TERMGIT_HTML_PROJECTGitLab-Projektpfad zum TerminoloGit-HTML-Projekt, das die vom HL7® FHIR® IG-Publisher erzeugten statischen HTML-Seiten hosten soll.ja[username]/terminologit-dev-htmlVariableAlleneinneinnein
TERMGIT_HTML_PROJECT_DEFAULT_BRANCHDefault-Branch des TerminoloGit HTML-Projekts.jamainVariableAlleneinneinnein
TERMGIT_BOT_CI_TOKENPersönlicher Zugriffstoken eines Fallback-GitLab-Benutzerkontos, das Push-Vorgänge ausführen darf, falls der Benutzer, der die Pipeline ausführt, nicht über die erforderlichen Berechtigungen verfügt. Dies ist im Falle von externen Terminologieanbietern praktisch.neindas-ist-ein-beispiel-tokenVariableAlleneinjanein
TERMGIT_BOT_USER_NAMEGitLab-Benutzername des Fallback-Benutzers.Ja, wenn TERMGIT_BOT_CI_TOKEN verwendet wird.bot-nameVariableAlleneinneinnein
TERMGIT_BOT_EMAILE-Mail des Fallback-Benutzers.Ja, wenn TERMGIT_BOT_CI_TOKEN verwendet wird.bot@email.comVariableAlleneinneinnein
IG_PUBLISHER_URLVerwenden Sie dies, um eine bestimmte Version des HL7® FHIR® IG Publisher zu verwenden. Wenn diese Variable nicht gesetzt ist, wird der IG-Publisher verwendet, der mit dem Docker-Image elgagmbh/fsh-ing-grounds ausgeliefert wird.neinaktuelle Version: https://github.com/HL7/fhir-ig-publisher/releases/latest/download/publisher.jar
bestimmte Version: https://github.com/HL7/fhir-ig-publisher/releases/download/1.3.28/publisher.jar
VariableAlleneinneinnein
GITLAB_CI_TOKENWird von create_gitlab_ci_token.sh erstellt und enthält das Token, das für den Push an andere GitLab-Repositories verwendet wird.automatisch erstelltein_CI_tokenVariableAlleneinneinnein
GITLAB_USER_OR_TERMGIT_BOT_EMAILWird von create_gitlab_ci_token.sh erstellt und enthält die E-Mail-Adresse, die zur Konfiguration von Git innerhalb eines Jobs verwendet wird.automatisch erstellteine@email.comVariableAlleneinneinnein
GITLAB_USER_OR_TERMGIT_BOT_NAMEWird von create_gitlab_ci_token.sh erstellt und enthält den Benutzernamen, der für die Konfiguration von Git innerhalb eines Jobs verwendet wird.automatisch erstelltein_benutzernameVariableAlleneinneinnein
CI_DO_FULL_IGPUB_CREATION_IN_BRANCHStandardmäßig werden alle Terminologien nur im Default-Branch vom IG-Publisher bearbeitet. Wenn diese Variable auf einen beliebigen Wert gesetzt wird, werden alle Terminologien vom IG-Publisher in allen Branches bearbeitet.neintrueVariableAlleneinneinnein
TURN_OFF_VERIFICATION_IN_REST_CALLSWenn auf true gesetzt, wird keine Zertifikatsüberprüfung durchgeführt.neinfalseVariableAlleneinneinnein
IG_PUB_TEMPLATE_URLURL des Repositorys, in dem das zu verwendende Template für den IG-Publisher gespeichert ist. Wird nichts angegeben, wird https://gitlab.com/elga-gmbh/terminologit-template.git verwendet.neinhttps://github.com/HL7/ig-template-base.gitVariableAlleneinneinnein
IG_PUB_TEMPLATE_BRANCHBranch des Template-Repositorys (siehe IG_PUB_TEMPLATE_URL), der für den IG-Publisher verwendet werden soll. Wird nichts angegeben, so wird der jeweilige Default-Branch verwendet.neindevVariableAlleneinneinnein
JAVA_OPTSErmöglicht es, Optionen an den Aufruf von Java für den IG-Publisher zu übergeben.nein-Xms13g -Xmx13g -XX:+UseG1GCVariableAlleneinneinnein

Die folgenden von GitLab vordefinierten CI/CD-Variablen haben auch Auswirkungen auf TerminoloGit:

SchlüsselBeschreibungWert (Beispiel)
CI_COMMIT_BRANCHName des Commit-Branches.dev
CI_DEFAULT_BRANCHName des Default-Branches des Projekts.main
CI_COMMIT_TITLEDie vollständige erste Zeile der Commit-Nachricht, auch bekannt als Commit-Titel. Commit-Nachrichten, die mit AUTOMATIC_COMMIT beginnen, sollen keine Pipeline auslösen. Wie eine Pipeline ohne Commit ausgelöst werden kann, erfahren Sie im Kapitel über das Starten einer Pipeline.Add terminology
CI_PIPELINE_SOURCEWie die Pipeline ausgelöst wurde.push, pipeline, etc.
CI_JOB_TOKENEin Token zur Authentifizierung bei bestimmten API-Endpunkten. Das Token ist so lange gültig, wie der Job ausgeführt wird. Wird für das Klonen anderer GitLab-Repositories verwendet.ein_CI_token
GITLAB_USER_LOGINDer Benutzername des Benutzers, der die Pipeline gestartet hat, es sei denn, der Job ist ein manueller Job. Bei manuellen Jobs ist der Wert der Benutzername des Benutzers, der den Job gestartet hat.gitlab_user_name
CI_PROJECT_PATHDer Projekt-Namensraum mit dem Projektnamen.elga-gmbh/termgit-dev

Integrationstest

Für Integrationstests werden die folgenden zusätzlichen CI/CD-Variablen benötigt:

SchlüsselBeschreibungErforderlichWert (Beispiel)TypUmgebungVariable schützenVariable maskierenVariablenreferenz erweitern
MALAC_CT_PROJECTGitLab-Projektpfad des MaLaC-CT-Projekts, das für den Integrationstest verwendet werden soll.Ja, wenn die Pipeline nicht im Rahmen des MaLaC-CT-Projekts gestartet wurde.elga-gmbh/malac-ctVariableAlleneinneinnein
MALAC_CT_PROJECT_BRANCHBranch des MaLaC-CT-Projekts, der für den Integrationstest ausgecheckt werden soll.Ja, wenn die Pipeline nicht innerhalb des MaLaC-CT-Projekts gestartet wurde.mainVariableAlleneinneinnein
CS_INPUT_FORMATDateiformat, das von MaLaC-CT als Quelle für Codesysteme zur Erstellung aller anderen Dateiformate verwendet werden soll.Ja, wenn die Pipeline nicht innerhalb des MaLaC-CT-Projekts gestartet wurde..1.propcsv.xlsxVariableAlleneinneinnein
VS_INPUT_FORMATDateiformat, das von MaLaC-CT als Quelle für Value-Sets zur Erstellung aller anderen Dateiformate verwendet werden soll.Ja, wenn die Pipeline nicht innerhalb des MaLaC-CT-Projekts gestartet wurde..1.propcsv.xlsxVariableAlleneinneinnein
TERMGIT_TERMINOLOGIES_PROJECTGitLab-Projektpfad des TerminoloGit-Projekts, dessen Terminologien im Integrationstest verwendet werden sollen.Ja, wenn die Pipeline nicht innerhalb des MaLaC-CT-Projekts gestartet wurde.elga-gmbh/termgitVariableAlleneinneinnein
TERMGIT_TERMINOLOGIES_PROJECT_BRANCHBranch des TerminoloGit-Projekts, dessen Terminologien im Integrationstest verwendet werden sollen.Ja, wenn die Pipeline nicht innerhalb des MaLaC-CT-Projekts gestartet wurde.mainVariableAlleneinneinnein

Die folgenden von GitLab vordefinierten CI/CD-Variablen wirken sich ebenfalls auf den Integrationstest aus:

SchlüsselBeschreibungWert (Beispiel)
CI_PIPELINE_SOURCEWie die Pipeline ausgelöst wurde.pipeline (erforderlich)
CI_JOB_URLDie URL der Job-Details. Wird verwendet, um die Download-Seite einer Terminologie zu erstellen.https://eine_url