Product Logo

Menü

Markdown Qualitätsprüfung

Diese CI Komponente können Sie verwenden, um Ihr Markdown-Dokument vor der Verarbeitung durch andere Komponenten auf ausgewählte Qualitätsmerkmale zu prüfen.

# gitlab-ci.yml
include:
  - component: $CI_SERVER_FQDN/open-code/document-writing-tools/document-writing-ci-components/md-quality@v2
    inputs:
      stage: tests
      md-path: dokument/

⚙️ Parameter

  • stage: Name des Stages, in dem die CI-Komponente ausgeführt wird.
    Standardwert: test

Quell-Dateien

  • md-path: Pfad zum Markdown-Dokument (Ordner im Repository, ausgehend vom Stammverzeichnis), das in eine PDF/UA-konforme PDF-Datei umgewandelt werden soll.
    Standardwert: document

Allgemeine Einstellungen

  • fail-on-severity: Über diesen Parameter können Sie festlegen, ab welcher Schweregradstufe (info | major | blocker) die Pipeline mit einem Fehler beendet werden soll.
    Standardwert: blocker

Ausgeführte Qualitätsprüfungen

Aktuell werden folgende Qualitätsprüfungen durchgeführt:

  • Validierung von internen Links: Prüft interne Links auf ihre Gültigkeit. Bei Test von internen Links wird geprüft, ob die verlinkte Datei im Repository vorhanden ist.
    Schweregrad: major

  • Validierung von externen Links: Prüft externe Links auf ihre Gültigkeit. Externe Links werden mit einer GET-Anfrage aufgerufen und als gültig betrachtet, wenn ein Statuscode kleiner als 400 zurückgegeben wird.
    Schweregrad: major

  • Alt-Texte für Bilder: Prüft, ob Bilder im Dokument einen Alt-Text haben. (![Alt-Text](<pfad> "Optionale Bildüberschrift"))
    Schweregrad: blocker

  • Duplikate Vorgaben-IDs: Im Kontext der IT-Architekturrichtlinien werden Vorgaben durch eine eindeutige ID identifiziert. Diese ID darf nur einmal im Dokument vorkommen.
    Schweregrad: blocker