Configuration d’une source de publication pour votre site GitHub Pages

À propos des sources de publication

Vous pouvez publier votre site lorsque des modifications sont poussées vers une branche spécifique ou vous pouvez écrire un workflow GitHub Actions pour publier votre site.

Si vous n’avez pas besoin de contrôle sur le processus de génération de votre site, nous vous recommandons de publier votre site lorsque des modifications sont poussées vers une branche spécifique. Vous pouvez spécifier la branche et le dossier à utiliser comme source de publication. La branche source peut être n’importe quelle branche de votre dépôt, et le dossier source peut être la racine du dépôt (/) sur la branche source ou un dossier /docs de la branche source. Chaque fois que des modifications sont poussées vers la branche source, les modifications du dossier source sont publiées sur votre site GitHub Pages.

Si vous souhaitez utiliser un processus de génération autre que Jekyll ou si vous ne souhaitez pas qu’une branche dédiée contienne vos fichiers statiques compilés, nous vous recommandons d’écrire un workflow GitHub Actions pour publier votre site. GitHub fournit des modèles de flux de travail pour les scénarios de publication courants afin de vous aider à rédiger votre flux de travail.

Publication à partir d’une branche

1. Assurez-vous que la branche que vous souhaitez utiliser comme source de publication existe déjà dans votre dépôt.

2. Dans GitHub, accédez au dépôt de votre site.

3. Sous le nom de votre référentiel, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

   

4. Dans la section « Code et automatisation » de la barre latérale, cliquez sur Pages.

5. Sous « Génération et déploiement », sous « Source », sélectionnez Déployer à partir d’une branche.

6. Sous « Génération et déploiement », utilisez le menu déroulant Branche et sélectionnez une source de publication.

1. Si vous le souhaitez, utilisez le menu déroulant de dossiers afin de sélectionner un dossier pour votre source de publication.

1. Cliquez sur Enregistrer.

Résolution des problèmes de publication à partir d’une branche

Si vous choisissez le dossier docs sur n’importe quelle branche comme source de publication, supprimez ultérieurement le dossier /docs de cette branche dans votre référentiel, votre site ne sera pas généré et vous recevrez un message d’erreur de génération de page en raison d’un dossier /docs manquant. Pour plus d’informations, consultez « Dépannage des erreurs de build Jekyll pour les sites GitHub Pages ».

Votre GitHub Pages site sera toujours déployé avec une GitHub Actions exécution de flux de travail, même si vous avez configuré votre GitHub Pages site pour qu’il soit créé à l’aide d’un autre outil CI. La plupart des workflows de CI externes « déploient » vers GitHub Pages en validant le résultat de la compilation dans la branche gh-pages du référentiel, et incluent généralement un fichier .nojekyll. Lorsque cela se produit, le GitHub Actions flux de travail détecte l’état que la branche n’a pas besoin d’une étape de génération et exécute uniquement les étapes nécessaires pour déployer le site sur GitHub Pages des serveurs.

Pour rechercher d’éventuelles erreurs liées à la compilation ou au déploiement, vous pouvez consulter l’exécution du workflow pour votre site GitHub Pages en examinant les exécutions de workflows de votre dépôt. Pour plus d’informations, consultez « Affichage de l’historique des exécutions de workflows ». Pour plus d’informations sur la réexécution du flux de travail en cas d’erreur, consultez Ré-exécution de workflows et de tâches.

Publication avec un flux de travail personnalisé GitHub Actions

Pour configurer votre site pour publier avec GitHub Actions :

1. Dans GitHub, accédez au dépôt de votre site.

2. Sous le nom de votre référentiel, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

   

3. Dans la section « Code et automatisation » de la barre latérale, cliquez sur Pages.

4. Sous « Générer et déployer », sous « Source », sélectionnez GitHub Actions.

5. GitHub suggère plusieurs modèles de flux de travail. Si vous disposez déjà d’un workflow pour publier votre site, vous pouvez ignorer cette étape. Sinon, choisissez l’une des options permettant de créer un GitHub Actions flux de travail. Pour plus d’informations sur la création de votre flux de travail personnalisé, consultez Création d’un flux de travail personnalisé GitHub Actions pour publier votre site.

GitHub Pages n’associe pas de flux de travail spécifique aux GitHub Pages paramètres. Toutefois, les GitHub Pages paramètres sont liés à l’exécution du flux de travail qui a récemment déployé votre site.

Création d’un flux de travail personnalisé GitHub Actions pour publier votre site

Pour plus d’informations sur GitHub Actions, consultez Documentation de GitHub Actions.

Lorsque vous configurez votre site à publier avec GitHub Actions, GitHub suggérerez des modèles de flux de travail pour les scénarios de publication courants. Le flux général d’un workflow est le suivant :

1. Déclenchez chaque fois qu’il y a un envoi vers la branche par défaut du référentiel ou chaque fois que le workflow est exécuté manuellement à partir de l’onglet Actions.
2. Utiliser l’action actions/checkout pour extraire le contenu du dépôt.
3. Si votre site le demande, générez les fichiers de site statiques.
4. Utiliser l’action actions/upload-pages-artifact pour charger les fichiers statiques en tant qu’artefact.
5. Si le workflow a été déclenché par une poussée vers la branche par défaut, utilisez l’action actions/deploy-pages pour déployer l’artefact. Cette étape est ignorée si le workflow a été activé par une pull request.

Les modèles de workflow utilisent un environnement de déploiement appelé github-pages. Si votre dépôt n’inclut pas déjà un environnement appelé github-pages, l’environnement est créé automatiquement. Nous vous recommandons d'ajouter une règle de protection du déploiement afin que seule la branche par défaut puisse être déployée dans cet environnement. Pour plus d’informations, consultez « Gestion des environnements pour le déploiement ».

Résolution des problèmes de publication avec un flux de travail personnalisé GitHub Actions

Pour plus d’informations sur la résolution des problèmes de votre GitHub Actions flux de travail, consultez Surveiller les workflows.