configlet-Workflow

Der configlet-Workflow nutzt das configlet-Tool, um zu prüfen, ob die (Konfigurations-)Dateien eines Tracks korrekt strukturiert sind, und zwar sowohl syntaktisch als auch semantisch. Dazu führt er configlet lint aus.

Die Prüfung der Dateiformatierung aktivieren

Tracks können configlet fmt verwenden, um die verschiedenen Konfigurationsdateien des Tracks zu formatieren. Mit demselben Befehl kannst du auch prüfen, ob alle Konfigurationsdateien korrekt formatiert sind.

Der configlet-Workflow unterstützt die Prüfung, ob die Konfigurationsdateien korrekt formatiert sind, aber das ist optional und standardmäßig deaktiviert. Um die Formatierung der Konfigurationsdateien ebenfalls prüfen zu lassen, geh so vor:

1. Erstelle eine Datei .github/org-wide-files-config.toml mit folgendem Inhalt

[configlet]
fmt = true

1. Nachdem diese Datei in main gemergt wurde, wird automatisch ein PR geöffnet, der den configlet.yml-Workflow wie folgt ändert:

  jobs:
    configlet:
      uses: exercism/github-actions/.github/workflows/configlet.yml@main
+     with:
+       fmt: true

1. Sobald dieser PR gemergt wurde, prüft der configlet-Workflow zusätzlich die Formatierung der Konfigurationsdateien des Tracks.

Quelle

Der Workflow ist in der Datei .github/workflows/configlet.yml definiert.