Zum Inhalt springen

Einen ArchScan ausführen und den Bericht lesen

ArchScan scannt Ihre Codebasis und erstellt einen vollständigen Bericht mit einer einzigen kategoriengewichteten Qualitätsbewertung.

Es gibt zwei Wege:

  • In der CI: Führen Sie den Runner in einer Push-/geplanten Pipeline aus - außerhalb eines MR-Kontexts wechselt er automatisch in den Vollscan-Modus (ArchScan) (siehe Den Runner zur CI hinzufügen).
  • Über das Panel: Verwenden Sie ArchScan → (Projekt) → Scan ausführen, um den neuesten Branch zu scannen.
# Image pulls are authorized with your INSTALLATION credential, not the project token
# (Settings → CI/CD → Variables):
# DOCKER_AUTH_CONFIG = {"auths":{"hub.apparch.io":{"auth":"base64(<installation-id>:<installation-key>)"}}}
archscan:
image: hub.apparch.io/collectors/dotnet:latest
rules:
- if: $CI_PIPELINE_SOURCE == "push"
variables:
APPARCH_Collector__Token: "$APPARCH_TOKEN"
APPARCH_Collector__ApiUrl: "https://api.yourdomain.com"
script:
# Optional flags: --modules archpilot,archscan (pin what runs)
# --fail-on critical (fail this step when findings at/above the level exist)
- apparch "$CI_PROJECT_DIR"

Der Bericht hat sieben Abschnitte:

  1. Gesamtbewertung - eine einzige kategoriengewichtete Bewertung + Status.
  2. Befunde - mit Code-Ausschnitt und Dateispeicherort.
  3. SOLID-Aufschlüsselung - Verstöße nach den fünf Prinzipien.
  4. Pakete - Abhängigkeiten und Versionen.
  5. Projekte - Metriken pro Projekt.
  6. Abhängigkeitskarte - interaktiver Graph.
  7. Export.

In der Berichtsdetailansicht zeigt der Tab Karte projektübergreifende Abhängigkeiten in einem interaktiven Graphen; Zyklen und Schichtverstöße erkennen Sie auf einen Blick.

Verwenden Sie Bericht → Export, um einen teilbaren Bericht zu erstellen. Die Berichtssprache wird pro Workspace festgelegt. Für PDF nutzen Sie die Funktion „Drucken → Als PDF speichern” Ihres Browsers.