Configuration du dépôt GitHub modèle
Comment configurer un dépôt GitHub modèle pour les étapes d'exercice de code, y compris les prérequis, les étapes de configuration et le dépannage.
Configuration du dépôt GitHub modèle
Les étapes d’exercice de code créent un dépôt GitHub privé pour chaque candidat à partir d’un dépôt modèle. Ce guide explique comment configurer correctement votre dépôt modèle.
Qu’est-ce qu’un dépôt modèle ?
Les dépôts modèles permettent de générer de nouveaux dépôts avec la même arborescence et les mêmes fichiers. Lorsqu’un candidat atteint une étape d’exercice de code, Kit utilise l’API GitHub pour créer une nouvelle copie privée de votre dépôt modèle.
Important : le dépôt source doit être explicitement marqué comme modèle sur GitHub. Un dépôt classique ne peut pas servir de modèle – l’API GitHub rejettera la requête.
Comment marquer un dépôt comme modèle
- Accédez à votre dépôt sur GitHub
- Cliquez sur Settings (icône d’engrenage dans la barre de navigation du dépôt)
- Dans General, repérez la section Template repository en haut de la page
- Cochez la case Template repository
- Cliquez sur Save changes (le paramètre prend effet immédiatement)
Une fois activé, GitHub affiche un badge « Template » sur la page du dépôt.
Checklist des prérequis
| Prérequis | Détails |
|---|---|
| GitHub App installée | Votre organisation doit avoir l’application GitHub Kit installée et active (Intégrations > GitHub) |
| Dépôt existant | Le org/repo spécifié dans la configuration de l’étape doit exister sur GitHub |
| Marqué comme modèle | Le dépôt doit avoir « Template repository » coché dans Settings > General |
| Accès accordé à l’application | L’installation de l’application GitHub Kit doit avoir accès au dépôt modèle |
| Organisation correspondante | L’installation de l’application GitHub doit couvrir l’organisation dans laquelle les dépôts des candidats seront créés |
Configurer le modèle dans Kit
- Accédez à votre offre d’emploi > Étapes
- Sélectionnez ou créez une étape Exercice de code
- Dans le champ GitHub Template, sélectionnez un dépôt dans la liste déroulante ou saisissez le nom
org/repo - La liste déroulante n’affiche que les dépôts déjà marqués comme modèles – si votre dépôt n’apparaît pas, vérifiez qu’il est bien marqué comme modèle sur GitHub
- Enregistrez la configuration de l’étape
Kit valide automatiquement que le dépôt est un modèle valide après l’enregistrement. En cas de problème, un avertissement s’affiche sur la carte de l’étape.
Bonnes pratiques pour les dépôts modèles
- Incluez un README clair avec les instructions de l’exercice, les attentes et les consignes de soumission
-
Ajoutez un
.gitignoreadapté au langage et au framework utilisés - Incluez du code de démarrage ou un squelette sur lequel les candidats pourront s’appuyer
- Restez minimaliste – n’incluez que le nécessaire pour démarrer
- Ajoutez une configuration CI (GitHub Actions) si vous souhaitez des tests automatisés sur les soumissions des candidats
- N’incluez pas de secrets, de clés API ou de code propriétaire
Dépannage
| Problème | Cause | Solution |
|---|---|---|
| Le candidat reste bloqué sur le spinner « Setting Up » | Le dépôt modèle n’est pas marqué comme modèle | Accédez à Settings > General du dépôt et cochez « Template repository » |
| Erreur « Setup encountered an issue » | Dépôt modèle introuvable ou non marqué comme modèle | Vérifiez que le dépôt existe et est marqué comme modèle, puis relancez la configuration |
| Dépôt modèle absent de la liste déroulante | Le dépôt n’est pas marqué comme modèle | Marquez-le comme modèle dans les paramètres GitHub, puis rechargez la page |
| Avertissement « GitHub App not installed » | Aucune connexion GitHub active | Installez l’application GitHub Kit depuis les paramètres des intégrations |
| Avertissement « GitHub template repository not set » | Le champ github_template est vide |
Sélectionnez un modèle dans la configuration de l’étape |
| Le candidat ne peut pas accéder à son dépôt | L’invitation GitHub n’a pas été envoyée ou acceptée | Vérifiez le nom d’utilisateur GitHub du candidat et le statut de l’invitation au dépôt |
Voir aussi
- Configuration des modèles de processus – configuration YAML pour les étapes d’exercice de code
- Documentation GitHub sur les dépôts modèles