ChecklistFabrik ("clf") hilft, Prozesse und Todo-Listen in Teams und Unternehmen zu standardisieren und die Fragen "Was ist als nächstes zu tun" oder "Wo bin ich im Prozess stehen geblieben" zu beantworten. Benötigt wird lediglich eine YAML-Datei, die den Ablauf als Checkliste definiert, Python zur Ausführung von ChecklistFabrik und ein Browser zur Anzeige der von clf erzeugten interaktiven HTML-Checkliste.
ChecklistFabrik lässt sich mittels pip install --user checklistfabrik installieren. Es wurde in der Linuxfabrik entwickelt, ist Open Source und steht unter der UNLICENSE.
Details und Dokumentation finden sich auf github.com/linuxfabrik.
Schritt 1: Checkliste als YAML-Template erstellen
Checklisten werden mit YAML definiert. Durch Features wie Jinja-Templating und verschiedene Steuerelemente ermöglicht ChecklistFabrik die Erstellung komplexer und dynamischer Prozesse. Für die Gestaltung von Elementen wie Fragen und Antworten wird Markdown unterstützt. Checklisten können modular aufgebaut und aus anderen Checklisten importiert werden.
Beispiel (Auszug):
title: 'Deploy Red Hat Build of Keycloak 22.0'
version: '2025050701'
report_path: '$HOME/deploy-keycloak-{{ now().strftime("%Y%m%d") }}.yml'
pages:
- title: 'Questionnaire'
tasks:
- linuxfabrik.clf.checkbox_input:
label: 'Target Platform?'
values:
- value: 'Linux'
- value: 'Windows'
fact_name: 'platform'
- title: 'Before you start'
tasks:
- linuxfabrik.clf.checkbox_input:
values:
- label: 'Make sure you have [OpenJDK 17](https://openjdk.java.net/) installed'
required: true
- title: 'Start Red Hat Build of Keycloak'
tasks:
- linuxfabrik.clf.checkbox_input:
values:
- label: 'On Linux: `bin/kc.sh start-dev`'
when:
- '"linux" in (platform | map("lower"))'Schritt 2: Checkliste ausführen
Das Python-Tool clf-play interpretiert die YAML-Datei, rendert sie in interaktives HTML, startet einen lokalen Python-Webserver und zeigt die Checkliste im Browser an.
clf-play --template examples/deploy-keycloak.yml
Schritt 3: Checkliste speichern
Der Fortschritt beim Abarbeiten der Checkliste kann jederzeit gespeichert werden. Die Speicherung der Vorlagen und Ergebnisse ("Reports") in Git-Repositories ermöglicht die Zusammenarbeit im Team, eine einfache Überwachung des Prozessfortschritts, bietet eine Rollback-Funktion sowie ein Audit-Protokoll.
