Comment créer une application GitHub Auto-Hébergée

Si vous utilisez Bencher Cloud, vous pouvez simplement vous inscrire ou vous connecter en utilisant le bouton GitHub.

Pour Bencher Self-Hosted, vous devrez disposer d’un plan Bencher Plus Enterprise, créer votre propre application GitHub et mettre à jour votre configuration de la console et la configuration du serveur API.

Créer une application GitHub

• Créez une Application GitHub
• Nom de l’application GitHub
  • Choisissez un nom unique (ex : Bencher pour Mon Entreprise)
• URL de la page d’accueil
  • Réglez-le sur votre URL de Console Bencher Auto-Hébergé (ex : https://bencher.example.com)
• Identification et autorisation des utilisateurs
  • URL de rappel
    • Réglez l’URL de rappel sur l’URL de votre Console Bencher Auto-Hébergé avec le chemin /auth/github (ex : https://bencher.example.com/auth/github)
  • ✅ Expirez les jetons d’autorisation des utilisateurs
  • ✅ Demandez l’autorisation de l’utilisateur (OAuth) pendant l’installation
  • ✅ Activez le flux de l’appareil
• Webhook
  • ❌ Active - Décocher cette case
• Permissions
  • Permissions du compte
    • Adresses email : Lecture seule
• Où cette application GitHub peut-elle être installée ?
  • 🔘 N’importe quel compte
• Cliquez sur Créer une application GitHub
• Maintenant sous Général pour l’application nouvellement créée
• Notez le Client ID (ex : Iv1.12864abcd1232048)
• Secrets du client
  • Cliquez sur Générer un nouveau secret client
  • Notez ce secret (ex : 00000abcd12345wxyz123456789abcdefgh0000)
• Ajoutez le logo PNG de Bencher sous les informations d’affichage
• Clés privées
  • Cliquez sur Générer une clé privée

Configuration de l’application GitHub

Interface utilisateur de la console

Définissez la variable d’environnement GITHUB_CLIENT_ID lorsque vous exécutez l’image Docker bencher-console. (ex : GITHUB_CLIENT_ID=Iv1.12864abcd1232048) Si l’ID du client est manquant, alors les boutons GitHub n’apparaîtront pas dans l’UI.

Serveur API

Ajoutez le client_id et le client_secret à la section plus.github de la config du serveur. Si la section GitHub est manquante, alors le serveur échouera pour toute demande d’authentification GitHub.

Dépôts liés

Mettez à jour le serveur API et la Console Bencher Auto-Hébergé vers v0.6.16 ou une version ultérieure avant de modifier ces paramètres.

Pour qu’un Projet puisse lier un dépôt GitHub pour ses exécutions détachées, réglez aussi ces paramètres pour l’application GitHub :

• Identification et autorisation des utilisateurs
  • URL de rappel
    • Réglez la première URL de rappel sur l’URL de votre Console Bencher Auto-Hébergé avec le chemin /console/github (ex : https://bencher.example.com/console/github). GitHub envoie l’utilisateur vers la première URL de rappel après qu’il a installé l’application.
    • Gardez ensuite l’URL de rappel avec le chemin /auth/github, pour la connexion (ex : https://bencher.example.com/auth/github). GitHub refuse une connexion dont l’URL de rappel n’est pas listée.
  • ✅ Demandez l’autorisation de l’utilisateur (OAuth) pendant l’installation
• Webhook
  • ✅ Active - Cochez cette case
  • URL du webhook
    • Réglez-la sur l’URL de votre serveur API Bencher Auto-Hébergé avec le chemin /v0/github/webhook (ex : https://api.bencher.example.com/v0/github/webhook)
  • Secret du webhook
    • Saisissez un secret aléatoire et notez-le (ex : 0123456789abcdef0123456789abcdef)
• Permissions
  • Permissions du dépôt
    • Contenu : Lecture et écriture
  • S’abonner aux événements
    • Laissez chaque événement décoché
• Notez le slug de l’application, la dernière partie de l’URL de sa page publique (ex : my-bencher-app dans https://github.com/apps/my-bencher-app)

Ajoutez le slug, la clé privée et le secret du webhook en tant que app à la section plus.github de la config du serveur.

🐰 Félicitations ! Vous avez appris comment configurer une application GitHub ! 🎉

Ajoutez Bencher aux actions GitHub ➡