Aller au contenu principal

Importer tes dépôts GitHub

Astrolabe lit le fichier catalog-info.yaml des dépôts d'une organisation GitHub et les ajoute au catalogue.

Tu le règles une fois, en administrateur. Ensuite, le catalogue se remplit tout seul toutes les 30 minutes.

Avant de commencer​

Le catalogue lit GitHub avec le jeton de l'intégration GitHub. Ajoute-la d'abord : voir GitHub › Ajouter l'intégration GitHub.

Le jeton a besoin des droits repo, read:org et read:user.

🔧 Régler le fournisseur GitHub​

  1. Dans la barre latérale, en bas, clique sur Administration.

  2. Sous PLATEFORME, clique sur Catalogue. L'onglet Fournisseurs s'ouvre.

  3. Sur la carte GitHub, clique sur Configurer.

  4. Dans Organisation, écris l'organisation à lire, comme dans https://github.com/<organisation>, par exemple acme.

  5. Laisse Hôte sur github.com.

  6. En bas du formulaire, coche Importer les membres et équipes GitHub.

  7. Clique sur Installer.

La fenêtre de rechargement s'affiche le temps que l'instance redémarre. Puis la page revient.

Chaque champ a son ?

Passe sur le ? à côté d'un champ pour voir ce qu'il attend, avec un exemple.

👥 Membres et équipes​

Importer les membres et équipes GitHub importe aussi les membres et les équipes de l'organisation. Ils peuvent alors se connecter avec GitHub et posséder des composants : owner: group:github/<équipe>. Passe sur le ? à côté pour le lire. Il demande l'Organisation ci-dessus : sans elle, le formulaire refuse avec Organisation est requis. Le jeton a besoin des droits read:org et read:user.

Pour les voir, clique sur Catalogue dans la barre latérale, puis sur l'onglet Users ou Groups.

Si la case n'est pas cochée, seuls les dépôts sont importés : personne ne peut se connecter avec GitHub, et le catalogue ne contient aucun utilisateur GitHub. Pour le changer plus tard, clique de nouveau sur Configurer sur la carte GitHub, coche ou décoche la case, puis clique sur Mettre à jour.

Les autres champs​

ChampCe qu'il fait
ID de l'application GitHubVide : Astrolabe lit avec le jeton.
Hôtegithub.com. Pour GitHub Enterprise, son nom de domaine, écrit exactement comme dans l'intégration GitHub.
Chemin du fichier de catalogueOù se trouve le fichier dans chaque dépôt. Vide : /catalog-info.yaml. Jokers permis : /**/catalog-info.yaml.
BrancheLa branche à lire. Vide : la branche par défaut de chaque dépôt.
Expression régulière des dépôtsSeulement les dépôts dont le nom correspond, par exemple ^team-.*.
Inclure les forksCoché : les dépôts forkés sont importés aussi.
Inclure les dépôts archivésCoché : les dépôts archivés sont importés aussi.
Sujets à inclureClique sur Ajouter Sujets à inclure et tape un topic : seulement les dépôts qui portent l'un de ces topics.
Sujets à exclureClique sur Ajouter Sujets à exclure et tape un topic : les dépôts qui le portent sont laissés de côté.
VisibilitéClique sur Ajouter Visibilité : seulement les dépôts de ces visibilités (public, private, internal). Vide : tous.
Vérifier que les fichiers existentCoché : vérifie que le fichier existe avant de l'ajouter. Plus lent, mais pas d'erreur pour un dépôt qui n'en a pas.
Dépôts par pageCombien de dépôts sont lus par requête. Par défaut : 25.

▶️ Lancer la collecte maintenant​

Tu ne veux pas attendre 30 minutes ?

  1. Sur Administration › Catalogue, trouve le tableau Collecte du catalogue.

  2. Sur la ligne GitHub, clique sur Lancer la collecte GitHub maintenant, dans la colonne Actions.

  3. Recharge la page. État indique Terminé. Détail dit combien de fichiers ont été trouvés, par exemple 3 fichiers de catalogue trouvés.

Tes composants sont maintenant dans Catalogue.

✅ C'est tout !

La suite : afficher l'onglet GitHub sur un composant.