GitHub Template-Repository einrichten
So konfigurieren Sie ein GitHub Template-Repository für Code-Aufgaben-Phasen, einschließlich Anforderungen, Einrichtungsschritten und Fehlerbehebung.
GitHub Template-Repository einrichten
Code-Aufgaben-Phasen erstellen für jeden Kandidaten ein privates GitHub-Repository aus einem Template-Repository. Diese Anleitung beschreibt, wie Sie Ihr Template-Repository korrekt konfigurieren.
Was ist ein Template-Repository?
Template-Repositories ermöglichen es, neue Repositories mit derselben Verzeichnisstruktur und denselben Dateien zu generieren. Wenn ein Kandidat eine Code-Aufgaben-Phase erreicht, erstellt Kit über die GitHub-API eine neue private Kopie Ihres Template-Repositorys.
Wichtig: Das Quell-Repository muss auf GitHub explizit als Template markiert sein. Ein reguläres Repository kann nicht als Template verwendet werden – die GitHub-API lehnt die Anfrage ab.
So markieren Sie ein Repository als Template
- Navigieren Sie zu Ihrem Repository auf GitHub
- Klicken Sie auf Settings (Zahnrad-Symbol in der Repository-Navigation)
- Unter General finden Sie den Abschnitt Template repository nahe dem Seitenanfang
- Aktivieren Sie das Kontrollkästchen Template repository
- Klicken Sie auf Save changes (die Einstellung wird sofort wirksam)
Sobald die Option aktiviert ist, zeigt GitHub ein „Template“-Badge auf der Repository-Seite an.
Anforderungen – Checkliste
| Anforderung | Details |
|---|---|
| GitHub App installiert | Ihre Organisation muss die Kit GitHub App installiert und aktiv haben (Integrationen > GitHub) |
| Repository existiert | Das in der Phasenkonfiguration angegebene org/repo muss auf GitHub existieren |
| Als Template markiert | Im Repository muss unter Settings > General die Option „Template repository“ aktiviert sein |
| App hat Zugriff | Die Kit GitHub App-Installation muss Zugriff auf das Template-Repository haben |
| Organisation stimmt überein | Die GitHub App-Installation muss die Organisation abdecken, in der Kandidaten-Repositories erstellt werden |
Das Template in Kit konfigurieren
- Navigieren Sie zu Ihrer Stellenausschreibung > Phasen
- Wählen oder erstellen Sie eine Code-Aufgaben-Phase
- Wählen Sie im Feld GitHub Template ein Repository aus dem Dropdown oder geben Sie den
org/repo-Namen ein - Das Dropdown zeigt nur Repositories an, die bereits als Template markiert sind – falls Ihr Repository nicht erscheint, überprüfen Sie, ob es auf GitHub als Template markiert ist
- Speichern Sie die Phasenkonfiguration
Kit validiert nach dem Speichern automatisch, ob das Repository ein gültiges Template ist. Bei Problemen erscheint eine Warnung auf der Phasenkarte.
Best Practices für Template-Repositories
- Fügen Sie eine aussagekräftige README hinzu mit Aufgabenstellung, Erwartungen und Abgaberichtlinien
-
Fügen Sie eine
.gitignorehinzu, die zur verwendeten Sprache und zum Framework passt - Stellen Sie Starter-Code bereit oder ein Grundgerüst, auf dem Kandidaten aufbauen können
- Halten Sie es minimal – nehmen Sie nur das auf, was Kandidaten zum Einstieg benötigen
- Fügen Sie eine CI-Konfiguration hinzu (GitHub Actions), wenn Sie automatisierte Tests für Kandidaten-Einreichungen wünschen
- Keine Secrets, API-Schlüssel oder proprietären Code einbinden
Fehlerbehebung
| Problem | Ursache | Lösung |
|---|---|---|
| Kandidat bleibt beim Spinner „Setting Up“ hängen | Template-Repository ist nicht als Template markiert | Navigieren Sie zu Settings > General des Repositorys und aktivieren Sie „Template repository“ |
| Fehler „Setup encountered an issue“ | Template-Repository nicht gefunden oder kein Template | Überprüfen Sie, ob das Repository existiert und als Template markiert ist, und lösen Sie die Einrichtung erneut aus |
| Template-Repository fehlt im Dropdown | Repository ist nicht als Template markiert | Markieren Sie es in den GitHub-Einstellungen als Template und laden Sie die Seite neu |
| Warnung „GitHub App not installed“ | Keine aktive GitHub-Verbindung | Installieren Sie die Kit GitHub App über die Integrationseinstellungen |
| Warnung „GitHub template repository not set“ | Das Feld github_template ist leer |
Wählen Sie ein Template in der Phasenkonfiguration aus |
| Kandidat kann nicht auf sein Repository zugreifen | GitHub-Einladung wurde nicht gesendet oder nicht angenommen | Überprüfen Sie den GitHub-Benutzernamen des Kandidaten und den Status der Repository-Einladung |
Siehe auch
- Prozessvorlagen-Konfiguration – YAML-Konfiguration für Code-Aufgaben-Phasen
- GitHub-Dokumentation zu Template-Repositories