Aller au contenu
KendorDocs

Comment importer un dossier ou une branche d’un dépôt

Pour les propriétaires et les éditeurs ·

Collez le lien de la page d’un dossier ou d’une branche chez votre hébergeur Git. Kendor n’importe que cette partie et fait du dossier la racine du projet du candidat.

Pour importer une partie d’un dépôt, ouvrez le dossier ou la branche chez votre hébergeur Git, copiez le lien depuis la barre d’adresse du navigateur et collez-le dans le champ de dépôt à la place du simple lien du dépôt. Kendor lit la branche et le dossier dans le lien, n’importe que ce dossier et en fait la racine du projet du candidat.

C’est adapté aux monorepos, aux dépôts qui regroupent plusieurs exercices côte à côte, et aux exercices qui vivent sur leur propre branche.

La branche peut aussi être une étiquette (tag) ou un hash de commit complet. La partie dossier est facultative : omettez-la pour importer tout le dépôt à cette branche.

Hébergeur Lien de branche ou de dossier
GitHub et GitHub Enterprise Server https://github.com/<owner>/<repo>/tree/<branch>/<folder>
GitLab et GitLab autogéré https://gitlab.com/<group>/<repo>/-/tree/<branch>/<folder>
Bitbucket https://bitbucket.org/<workspace>/<repo>/src/<branch>/<folder>
Gitea et Forgejo https://git.example.com/<owner>/<repo>/src/branch/<branch>/<folder>

Pour Gitea et Forgejo, utilisez src/tag/<tag> pour une étiquette et src/commit/<hash> pour un commit. Les liens GitLab peuvent inclure des sous-groupes, comme gitlab.com/acme/backend/platform/-/tree/main/services/api.

Les liens vers un seul fichier, comme les pages /blob/ de GitHub, ne sont pas acceptés.

Exemples

Un service Node.js dans un monorepo sur GitHub :

https://github.com/acme/platform/tree/main/services/api

Kendor importe services/api depuis la branche main. Un fichier qui se trouvait à services/api/package.json dans le dépôt se trouve à package.json dans l’exercice.

Une version étiquetée d’un projet GitLab, dépôt entier :

https://gitlab.com/acme/rate-limiter/-/tree/v2.1.0

Un dossier d’exercice sur Bitbucket :

https://bitbucket.org/acme/exercises/src/main/booking-api

Un commit figé sur un serveur Gitea :

https://git.example.com/acme/platform/src/commit/4f9c2e1d8a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d/services/api

Ce que change le changement de racine

Le dossier vers lequel vous faites pointer le lien devient le sommet du projet du candidat. Cela affecte quelques points :

  • Configuration de démarrage. Kendor cherche kendor.yaml à la racine du dossier, pas à la racine du dépôt. Si le dossier n’en a pas, Kendor détecte la configuration à partir des fichiers propres du dossier, comme son package.json ou son go.mod.
  • Les fichiers hors du dossier ne sont pas inclus. Si le dossier dépend de quelque chose ailleurs dans le dépôt, comme un paquet partagé ou un fichier de verrouillage à la racine du dépôt, le candidat ne l’aura pas. Importez plutôt le dossier parent, ou copiez ce qui est nécessaire dans le dossier.
  • Les limites s’appliquent au dossier. Les limites de 5 000 fichiers et de 50 Mo ne comptent que les fichiers du dossier, après exclusion des dossiers de dépendances. Si un dépôt entier est trop gros, importer le dossier dont vous avez besoin est généralement la solution.
  • Le titre suggéré vient du nom du dossier : services/booking-api suggère donc Booking Api. Vous pouvez le modifier avant d’ajouter.

Le résultat de Vérifier affiche le dossier et la branche ou le commit après le nom du dépôt, pour que vous puissiez confirmer ce que vous allez importer avant de choisir Ajouter le défi.

Noms de branche contenant une barre oblique

Dans un lien, Kendor considère le premier segment après tree/ (ou src/) comme la branche et tout ce qui suit comme le dossier. Une branche appelée feature/new-api serait lue comme la branche feature et le dossier new-api.

Pour une branche de ce genre :

  • Sur github.com, utilisez le raccourci owner/repo@feature/new-api. Il importe tout le dépôt à cette branche, sans choisir de dossier.
  • Sur n’importe quel hébergeur, utilisez un lien avec le hash du commit à la place du nom de branche. Copiez le hash du dernier commit de la branche et placez-le à l’endroit de la branche.

Erreurs courantes

  • No files found under "services/api" signifie que le dossier n’existe pas sur cette branche, ou ne contient que des dossiers de dépendances ou de build que Kendor laisse de côté. Vérifiez l’orthographe, y compris les majuscules et minuscules.
  • Repository or ref not found signifie que la branche, l’étiquette ou le commit n’existe pas, ou que le dépôt est privé. Voir Importer un dépôt privé.
  • Use a repository or /tree/<branch>/<folder> URL (ou l’équivalent GitLab, Bitbucket ou Gitea) signifie que le lien pointe vers autre chose qu’un dépôt, une branche ou un dossier, comme un fichier, une pull request ou une issue.
Cet article vous a-t-il aidé ?