Konfiguracja szablonowego repozytorium GitHub
Jak skonfigurować szablonowe repozytorium GitHub dla etapów zadań programistycznych, w tym wymagania, kroki konfiguracji i rozwiązywanie problemów.
Konfiguracja szablonowego repozytorium GitHub
Etapy zadań programistycznych tworzą prywatne repozytorium GitHub dla każdego kandydata na podstawie szablonowego repozytorium. Ten przewodnik opisuje, jak prawidłowo skonfigurować szablonowe repozytorium.
Czym jest szablonowe repozytorium?
Szablonowe repozytoria umożliwiają generowanie nowych repozytoriów z taką samą strukturą katalogów i plikami. Gdy kandydat dotrze do etapu zadania programistycznego, Kit korzysta z API GitHub, aby utworzyć nową prywatną kopię szablonowego repozytorium.
Ważne: Repozytorium źródłowe musi być jawnie oznaczone jako szablon na GitHub. Zwykłe repozytorium nie może być użyte jako szablon – API GitHub odrzuci takie żądanie.
Jak oznaczyć repozytorium jako szablon
- Przejdź do swojego repozytorium na GitHub
- Kliknij Settings (ikona zębatki w nawigacji repozytorium)
- W sekcji General znajdź Template repository w górnej części strony
- Zaznacz pole Template repository
- Kliknij Save changes (ustawienie działa natychmiast)
Po włączeniu GitHub wyświetli plakietkę “Template” na stronie repozytorium.
Lista kontrolna wymagań
| Wymaganie | Szczegóły |
|---|---|
| Zainstalowana aplikacja GitHub | W Twojej organizacji Kit GitHub App musi być zainstalowana i aktywna (Integracje > GitHub) |
| Repozytorium istnieje | Repozytorium org/repo podane w konfiguracji etapu musi istnieć na GitHub |
| Oznaczone jako szablon | Repozytorium musi mieć zaznaczoną opcję “Template repository” w Settings > General |
| Aplikacja ma dostęp | Instalacja Kit GitHub App musi mieć dostęp do szablonowego repozytorium |
| Zgodność organizacji | Instalacja GitHub App musi obejmować organizację, w której będą tworzone repozytoria kandydatów |
Konfiguracja szablonu w Kit
- Przejdź do Job Posting > Stages
- Wybierz lub utwórz etap Code Assignment
- W polu GitHub Template wybierz repozytorium z listy rozwijanej lub wpisz nazwę w formacie
org/repo - Lista rozwijana pokazuje tylko repozytoria oznaczone jako szablony – jeśli repozytorium nie pojawia się na liście, sprawdź, czy jest oznaczone jako szablon na GitHub
- Zapisz konfigurację etapu
Po zapisaniu Kit automatycznie zweryfikuje, czy repozytorium jest prawidłowym szablonem. W przypadku problemu na karcie etapu pojawi się ostrzeżenie.
Dobre praktyki dla szablonowych repozytoriów
- Dołącz czytelny README z instrukcjami zadania, oczekiwaniami i wytycznymi dotyczącymi przesyłania rozwiązania
-
Dodaj plik
.gitignoreodpowiedni dla danego języka programowania i frameworka - Dołącz kod startowy lub szablon bazowy, na którym kandydaci mogą budować rozwiązanie
- Ogranicz zawartość do minimum – umieść tylko to, czego kandydaci potrzebują na start
- Dodaj konfigurację CI (GitHub Actions), jeśli chcesz uruchamiać automatyczne testy na rozwiązaniach kandydatów
- Nie umieszczaj sekretów, kluczy API ani zastrzeżonego kodu
Rozwiązywanie problemów
| Problem | Przyczyna | Rozwiązanie |
|---|---|---|
| Kandydat utknął na spinnerze “Setting Up” | Repozytorium nie jest oznaczone jako szablon | Przejdź do Settings > General repozytorium i zaznacz “Template repository” |
| Błąd “Setup encountered an issue” | Repozytorium szablonowe nie zostało znalezione lub nie jest szablonem | Sprawdź, czy repozytorium istnieje i jest oznaczone jako szablon, a następnie ponownie uruchom konfigurację |
| Repozytorium szablonowe nie pojawia się na liście | Repozytorium nie jest oznaczone jako szablon | Oznacz je jako szablon w ustawieniach GitHub, a następnie odśwież stronę |
| Ostrzeżenie “GitHub App not installed” | Brak aktywnego połączenia z GitHub | Zainstaluj Kit GitHub App w ustawieniach Integracji |
| Ostrzeżenie “GitHub template repository not set” | Pole github_template jest puste |
Wybierz szablon w konfiguracji etapu |
| Kandydat nie ma dostępu do repozytorium | Zaproszenie GitHub nie zostało wysłane lub zaakceptowane | Sprawdź nazwę użytkownika GitHub kandydata i status zaproszenia do repozytorium |
Zobacz także
- Konfiguracja szablonu procesu – konfiguracja YAML dla etapów zadań programistycznych
- Dokumentacja szablonowych repozytoriów GitHub