À propos des erreurs de build Jekyll pour les sites GitHub Pages

À propos des erreurs de build Jekyll

Si vous publiez depuis une branche, parfois, GitHub Pages ne tente pas de générer votre site après avoir poussé les changements vers la source de publication de votre site.

• Vous poussez avec une clé de déploiement. Si vous souhaitez automatiser les poussées vers le dépôt de votre site, vous pouvez configurer un utilisateur d’ordinateur à la place. Pour plus d’informations, consultez « Gestion des clés de déploiement ».
• Vous utilisez un service CI qui n’est pas configuré pour générer votre source de publication. Par exemple, Travis CI ne génère pas la branche gh-pages, sauf si vous ajoutez la branche à une liste sécurisée. Pour plus d’informations, consultez Personnalisation du build sur Travis CI ou la documentation de votre service CI.

Si Jekyll tente de générer votre site et rencontre une erreur, vous recevez un message d’erreur de build. Il existe deux principaux types de messages d’erreur de build Jekyll.

• Un message « Avertissement de génération de page » signifie que votre build s’est terminée correctement, mais que vous devrez peut-être apporter des changements pour éviter des problèmes à venir.
• Un message « Échec de génération de page » signifie que votre build a échoué. Si Jekyll est en mesure de détecter une raison de l’échec, un message d’erreur descriptif s’affiche.

Pour plus d’informations sur la résolution des erreurs de build, consultez Résolution des erreurs de build Jekyll pour les sites GitHub Pages.

Afficher les échecs de construction de votre dépôt sur GitHub

Vous pouvez voir les échecs de compilation (mais pas les avertissements de compilation) pour votre site dans l'onglet Paramètres du référentiel de votre site.

Affichage des messages d’erreur de build Jekyll en local

Nous vous recommandons de tester votre site localement, ce qui vous permet de voir les messages d'erreur de construction sur la ligne de commande, et de corriger tout échec de construction avant de pousser les changements vers GitHub. Pour plus d’informations, consultez « Test de votre site GitHub Pages localement avec Jekyll ».

Affichage des messages d’erreur de build Jekyll dans votre demande de tirage

Si vous publiez à partir d'une branche, lorsque vous créez une demande d'extraction pour mettre à jour votre source de publication sur GitHub, vous pouvez voir des messages d'erreur de construction dans l'onglet Vérifications de la demande de tirage. Pour plus d’informations, consultez « À propos des vérifications d’état ».

Si vous publiez avec un workflow GitHub Actions personnalisé afin de voir les messages d’erreur de version dans votre demande de tirage, vous devez configurer votre workflow pour qu’il s’exécute sur le déclencheur pull_request. Lorsque vous effectuez cette opération, nous vous recommandons d’ignorer les étapes de déploiement si le workflow a été déclenché par l’événement pull_request. Cela vous permet de voir les erreurs de build sans déployer les modifications de votre demande de tirage sur votre site. Pour plus d’informations, consultez « Événements qui déclenchent des flux de travail » et « Évaluer les expressions dans les workflows et les actions ».

Affichage des erreurs de build Jekyll par e-mail

Si vous publiez à partir d'une branche, lorsque vous apportez des modifications à votre source de publication sur GitHub, GitHub Pages tentera de construire votre site. Si la build échoue, vous recevez un e-mail dans votre adresse e-mail principale.

Si vous publiez avec un workflow GitHub Actions personnalisé afin de recevoir les e-mails sur les erreurs de build dans votre demande de tirage, vous devez configurer votre workflow pour qu’il s’exécute sur le déclencheur pull_request. Lorsque vous effectuez cette opération, nous vous recommandons d’ignorer les étapes de déploiement si le workflow a été déclenché par l’événement pull_request. Cela vous permet de voir les erreurs de build sans déployer les modifications de votre demande de tirage sur votre site. Pour plus d’informations, consultez « Événements qui déclenchent des flux de travail » et « Évaluer les expressions dans les workflows et les actions ».

Affichage des messages d’erreur de build Jekyll dans votre demande de tirage avec un service CI tiers

Vous pouvez configurer un service tiers, tel que Travis CI, pour afficher les messages d’erreur après chaque commit.

1. Si ce n’est déjà fait, ajoutez un fichier appelé Gemfile à la racine de votre source de publication, avec le contenu suivant :

   source `https://rubygems.org`
   gem `github-pages`
   

2. Configurez le dépôt de votre site pour le service de test de votre choix. Par exemple, pour utiliser Travis CI, ajoutez un fichier appelé .travis.yml à la racine de votre source de publication, avec le contenu suivant :

   language: ruby
   rvm:
     - 2.3
   script: "bundle exec jekyll build"
   

3. Vous devrez peut-être activer votre dépôt avec le service de test tiers. Pour plus d’informations, consultez la documentation de votre service de test.