Orbit
Connexion d'un référentiel GitHub
Before Orbit can deploy anything from GitHub you install the Kapsule Orbit GitHub App on your GitHub account or organisation and choose which repositories it can see. This guide walks through the…
Avant qu'Orbit ne puisse déployer quoi que ce soit depuis GitHub, vous devez installer l'application GitHub Kapsule Orbit sur votre compte ou organisation GitHub et choisir les repositories qu'elle peut voir. Ce guide vous accompagne tout au long de l'installation, de la sélection d'un repository, de la création du projet, et de ce qu'il faut faire quand un repository attendu n'apparaît pas.
Avant de commencer
Vous devez avoir la permission d'installer une application GitHub sur le compte ou l'organisation qui possède le repository. Sur un compte personnel, c'est automatique. Sur une organisation, vous devez soit être propriétaire, soit avoir un propriétaire qui approuve votre demande d'installation à partir des paramètres de l'organisation.
Étape 1 : Installer l'application GitHub Kapsule Orbit
- Dans KPanel, cliquez sur Orbit dans la barre latérale gauche.
- Cliquez sur New project.
- Laissez le mode défini sur Import Git Repo.
- À l'étape 1, cliquez sur Connect GitHub.
Vous êtes envoyé vers GitHub pour installer l'application Kapsule Orbit. GitHub vous demande où l'installer (votre compte personnel ou une organisation) puis si vous voulez accorder l'accès à All repositories ou Only select repositories.
Choisissez Only select repositories et cochez uniquement les repositories que vous prévoyez de déployer. Vous pouvez en ajouter d'autres plus tard depuis GitHub sans déconnecter ou recréer quoi que ce soit dans Orbit, et cela limite les risques de l'intégration.
Quand vous avez terminé, GitHub vous renvoie vers KPanel. L'étape 1 affiche maintenant Just connected, et vos repositories se chargent à l'étape 2.
Étape 2 : Sélectionner un repository
Vos repositories accessibles apparaissent sous forme de liste. Cliquez sur Select sur celui que vous voulez déployer. Les repositories privés portent un badge Private ; Orbit déploie aussi bien les repositories publics que privés.
Une fois sélectionné, le repository affiche un badge Selected, et un lien Change vous permet d'en choisir un autre.
Si un repository est manquant
Orbit ne peut afficher que ce que l'application GitHub peut voir. Si un repository attendu n'est pas là :
- Cliquez sur Reconnect GitHub à l'étape 1 pour relancer le flux d'installation, ou ouvrez directement github.com/settings/installations.
- Ouvrez l'installation Kapsule Orbit et ajoutez le repository manquant sous Repository access.
- Retournez dans KPanel. La liste s'actualise.
Si le panneau affiche No repos accessible, l'application est installée mais aucun repository ne lui a été accordé. Ouvrez les paramètres de l'application GitHub et accordez l'accès à au moins un repository.
Autres causes courantes :
- Le repository appartient à une organisation sur laquelle vous n'avez pas installé l'application. L'installer sur votre compte personnel ne couvre pas les repositories d'organisation.
- Un propriétaire d'organisation n'a pas encore approuvé votre demande d'installation. Tant qu'il ne le fait pas, l'application existe mais ne voit rien.
- Le repository a été transféré ou renommé après l'installation de l'application. Relancez le flux d'installation pour actualiser ce qu'Orbit peut voir.
Étape 3 : Configurer votre projet
Avec un repository sélectionné, l'étape 3 demande deux champs :
| Champ | Ce qu'il fait |
|---|---|
| Project Name | Le nom d'affichage dans KPanel, par exemple my-app |
| Deploy URL | Le sous-domaine sous kaps.run, donc my-app devient my-app.kaps.run |
Cliquez sur Create project. Orbit clone le repository, met en file d'attente votre première compilation, et vous amène à l'aperçu du projet où vous pouvez regarder le flux de journal.
Le slug Deploy URL est défini une fois à la création et ne peut pas être modifié après. Si vous voulez une adresse publique différente plus tard, attachez un domaine personnalisé plutôt que d'essayer de renommer le slug. Voir Adding a Custom Domain to Your Project.
Ce qu'Orbit configure automatiquement
La création du projet configure le push-to-deploy pour vous. Il n'y a pas de webhook à configurer manuellement :
- Les pushes vers votre branche de production mettent en file d'attente un déploiement de production.
- Si Branch previews est activé, les pushes vers toute autre branche génèrent un aperçu isolé à
branch-<branch-name>.kaps.run. Voir Branch Preview Deployments in Orbit. - L'activité des pull requests est suivie, donc un déploiement d'aperçu affiche le numéro de PR auquel il appartient.
- Fermer ou fusionner une pull request met en pause son aperçu, et le stockage est récupéré dans environ un jour.
Conditionner les déploiements sur GitHub Actions
Si vous exécutez des tests dans GitHub Actions, vous pouvez faire en sorte qu'Orbit les attende. Dans Settings, puis CI required checks, entrez les noms exacts des tâches Actions, séparés par des virgules, par exemple build,test,lint. Tous les contrôles nommés doivent passer avant qu'un déploiement de production déclenché par un push ne se produise. Un échec CI annule automatiquement le déploiement Orbit.
Cela s'applique uniquement à la branche de production.
Reconnecter ou modifier votre installation
Pour changer les repositories qu'Orbit peut voir :
- Cliquez sur Orbit, puis New project.
- À l'étape 1, cliquez sur Reconnect pour relancer le flux d'installation de l'application GitHub.
Ou gérez l'installation directement à github.com/settings/installations. Les modifications là-bas sont récupérées la prochaine fois qu'Orbit affiche vos repositories.
Déconnecter GitHub
À l'étape 1 de New project, cliquez sur Disconnect.
La déconnexion supprime le lien entre votre compte Kapsule et GitHub. Vos projets et leur historique de déploiement sont conservés, et le déploiement actuellement actif continue à servir le trafic, mais les déploiements déclenchés par des pushes s'arrêtent jusqu'à ce que vous reconnectiez. Les webhooks de déploiement continuent de fonctionner, car ils récupèrent la tête de branche via la connexion du fournisseur : si la connexion est supprimée, un appel de webhook échoue avec une erreur plutôt que de déployer du code obsolète.
Lecture associée
- Deploying Your Project pour le cycle de déploiement complet et les portes qui le contrôlent
- Configuring Your Build Command and Output Directory si la première compilation échoue ou sert le mauvais contenu
- Connecting a GitLab Repo et Connecting a Bitbucket Repo pour les autres fournisseurs