Markdown Qualitätsprüfung

Diese CIAbkürzung für „Continuous Integration“ – eine Entwicklungspraxis, bei der Codeänderungen automatisch gebaut, getestet und häufig in ein zentrales Repository integriert werden, um Integrationsprobleme frühzeitig zu erkennen und eine hohe Codequalität sicherzustellen. 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 CIAbkürzung für „Continuous Integration“ – eine Entwicklungspraxis, bei der Codeänderungen automatisch gebaut, getestet und häufig in ein zentrales Repository integriert werden, um Integrationsprobleme frühzeitig zu erkennen und eine hohe Codequalität sicherzustellen.-Komponente ausgeführt wird.
Standardwert: test

Quell-Dateien

md-path: Pfad zum Markdown-Dokument (Ordner im RepositoryEin zentraler, versionskontrollierter Speicherort für Quellcode und zugehörige Dateien, der die gemeinsame Entwicklung und Änderungsverfolgung erleichtert., ausgehend vom Stammverzeichnis), das in eine PDFPortable Document Format/UAUniversal Accessibility-konforme PDFPortable Document Format-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 PipelineEine Pipeline bezeichnet eine Reihe automatisierter Schritte zur Optimierung des Softwarebereitstellungsprozesses. Dazu gehören das Bauen, Testen und Bereitstellen von Code. Dies verbessert den Entwicklungsprozess durch Automatisierung, besonders während Integrations- und Testphasen, reduziert manuelle Fehler, beschleunigt Produktzyklen und liefert kontinuierliches Feedback. 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 RepositoryEin zentraler, versionskontrollierter Speicherort für Quellcode und zugehörige Dateien, der die gemeinsame Entwicklung und Änderungsverfolgung erleichtert. 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 ITInformationstechnik-Architekturrichtlinien werden Vorgaben durch eine eindeutige IDAbkürzung für „Identifier“ – ein eindeutiger Wert oder Token, der verwendet wird, um eine Entität von anderen zu unterscheiden. identifiziert. Diese IDAbkürzung für „Identifier“ – ein eindeutiger Wert oder Token, der verwendet wird, um eine Entität von anderen zu unterscheiden. darf nur einmal im Dokument vorkommen.
Schweregrad: blocker