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

Vous pouvez configurer votre site GitHub Pages pour qu'il soit publié lorsque les modifications sont poussées vers une branche spécifique, ou vous pouvez écrire un flux de travail GitHub Actions pour publier votre site.

Qui peut utiliser cette fonctionnalité ?

People with admin or maintainer permissions for a repository can configure a publishing source for a GitHub Pages site.

GitHub Pages est disponible dans les référentiels publics avec GitHub Free et GitHub Free pour les organisations, et dans les référentiels publics et privés avec GitHub Pro, GitHub Team, GitHub Enterprise Cloud et GitHub Enterprise Server. Pour plus d’informations, consultez « Plans de GitHub ».

GitHub Pages utilise désormais GitHub Actions pour exécuter la version de Jekyll. Lorsque vous utilisez une branche comme source de votre version, GitHub Actions doit être activé dans votre référentiel si vous souhaitez utiliser le flux de travail Jekyll prédéfini. Comme alternative, si GitHub Actions n’est pas disponible ou désactivé, l’ajout d’un fichier .nojekyll à la racine de votre branche source contournera le processus de version de Jekyll et déploiera le contenu directement. Pour plus d'informations sur l'activation des GitHub Actions, consultez « Gestion des paramètres de GitHub Actions pour un dépôt ».

Dans cet article

À 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 workflow pour les scénarios de publication courants afin de vous aider à écrire votre workflow.

Warning

Les sites > GitHub Pages sont accessibles au public sur Internet, même si le référentiel du site est privé (si votre plan ou votre organisation le permet). Si vous avez des données sensibles dans le dépôt de votre site, vous pouvez les supprimer avant publication. Pour plus d’informations, consultez « À propos des dépôts ».

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 dépôt, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

    Capture d’écran d’un en-tête de dépôt montrant les onglets. L’onglet « Paramètres » est mis en évidence avec un encadré orange foncé.

  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.

    Capture d’écran des paramètres Pages dans un dépôt GitHub. Un menu permettant de sélectionner une branche pour une source de publication, intitulé « Aucun », est indiqué en orange foncé.

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

    Capture d’écran des paramètres Pages dans un dépôt GitHub. Un menu permettant de sélectionner un dossier pour une source de publication, intitulé « /(root) », est présenté en orange foncé.

  8. Cliquez sur Enregistrer.

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

Note

If your repository contains symbolic links, you will need to publish your site using a GitHub Actions workflow. For more information about GitHub Actions, see "Documentation GitHub Actions."

Note

  • Si vous publiez à partir d’une branche et votre site n’a pas été publié automatiquement, assurez-vous qu’une personne avec des autorisations d’administrateur et une adresse e-mail vérifiée a effectué une poussée vers la source de publication.
  • Les commits envoyés par un workflow GitHub Actions qui utilise le GITHUB_TOKEN ne déclenchent pas de build GitHub Pages.

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 « Résolution des erreurs de build Jekyll pour les sites GitHub Pages ».

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

Pour rechercher des erreurs potentielles avec la génération ou le déploiement, vous pouvez vérifier l’exécution du workflow pour votre site GitHub Pages en examinant les exécutions de workflow de votre référentiel. 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 travaux.

Publication avec un workflow GitHub Actions personnalisé

Pour configurer votre site à publier avec GitHub Actions :

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

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

    Capture d’écran d’un en-tête de dépôt montrant les onglets. L’onglet « Paramètres » est mis en évidence avec un encadré orange foncé.

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

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

  5. GitHub proposera plusieurs modèles de workflow. 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 workflow GitHub Actions. Pour plus d’informations sur la création de votre flux de travail personnalisé, consultez Création d’un flux de travail GitHub Actions personnalisé pour publier votre site.

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

Création d’un workflow GitHub Actions personnalisé pour publier votre site

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

Lorsque vous configurez votre site pour publier avec GitHub Actions, GitHub vous propose des modèles de workflow pour les scénarios de publication les plus 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érer les fichiers de sites 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é déclenché par une demande de tirage.

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 ».

Note

Un fichier CNAME dans votre fichier de dépôt n’ajoute ni ne supprime automatiquement un domaine personnalisé. Au lieu de cela, vous devez configurer le domaine personnalisé via vos paramètres de dépôt ou via l’API. Pour plus d’informations, consultez « Gestion d’un domaine personnalisé pour votre site GitHub Pages » et « Points de terminaison d’API REST pour GitHub Pages ».

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

Pour obtenir des informations sur la résolution des problèmes liés à votre flux de travail GitHub Actions, consultez Monitoring et résolution des problèmes de workflows.