Guides/Outils/Utiliser des déploiements GitHub sur WordPress.com

Utiliser des déploiements GitHub sur WordPress.com

GitHub Deployments intègre vos dépôts GitHub directement à votre site WordPress.com, ce qui vous permet d’utiliser un flux de travail automatisé et contrôlé par les versions pour déployer des extensions, des thèmes ou des modifications complètes du site. Ce guide décrit le processus de configuration et explique comment gérer vos dépôts connectés.

Cette fonctionnalité est disponible pour les sites utilisant les plans WordPress.com Business et Commerce. Si vous avez un plan Business, assurez-vous de l’activer. Les sites gratuits et les sites utilisant les plans Personnel et Premium doivent mettre à niveau leur plan pour avoir accès à cette fonctionnalité.

Didacticiel vidéo

Cette vidéo est en anglais.
YouTube propose des fonctions de traduction automatique pour que vous puissiez la visionner dans votre langue :

Pour afficher les sous-titres automatiques :

  1. Lancez la vidéo.
  2. Cliquez sur ⚙️ Paramètres (en bas à droite de la vidéo).
  3. Sélectionnez Sous-titres/CC.
  4. Choisissez Traduire automatiquement.
  5. Sélectionnez votre langue.

Pour écouter avec le doublage automatique (expérimental) :

  1. Cliquez sur ⚙️ Paramètres.
  2. Sélectionnez Piste audio.
  3. Sélectionnez la langue dans laquelle vous souhaitez écouter la vidéo.

ℹ️ Les traductions et doublages sont générés par Google, peuvent comporter des imprécisions et ne sont pas encore disponibles pour toutes les langues.

Connecter un dépôt

Avant de pouvoir déployer un dépôt GitHub sur votre site WordPress.com, vous devez configurer la connexion entre les deux à l’aide des étapes suivantes :

  1. Visitez votre page Sites : https://wordpress.com/sites
  2. Cliquez sur le nom de votre site pour voir l’aperçu du site.
  3. Cliquez sur l’onglet Déploiements.
  4. Cliquez sur le bouton « Connecter le dépôt ». Ensuite, si vos dépôts sont listés, vous avez déjà connecté votre compte GitHub. Passer à l’étape 11.
  5. Cliquez sur le bouton « Installer l’applicationWordPress.com ».
  6. Une nouvelle fenêtre s’ouvre et vous êtes invité à vous connecter à votre compte GitHub si ce n’est déjà fait. Ensuite, vous voyez cet écran :
Capture d’écran de l’invite vous demandant le droit de connecter votre compte GitHub à WordPress.com pour les développeurs.
  1. Cliquez sur le bouton « Autoriser WordPress.com pour les développeurs ».
  2. Sélectionnez l’organisation ou le compte GitHub contenant votre dépôt.
  3. Sélectionnez le ou les dépôts que vous souhaitez connecter :
    • Tous les dépôts : si vous sélectionnez cette option, WordPress.com aura accès à tous les dépôts actuels et futurs appartenant au compte GitHub sélectionné. Cela inclut les dépôts publics en lecture seule.
    • Sélectionner uniquement les dépôts : sélectionner cette option vous permettra de choisir les dépôts auxquels WordPress.com peut accéder sur le compte GitHub sélectionné. 
  4. Après avoir sélectionné une option, cliquez sur le bouton Installer.
  5. La nouvelle fenêtre se fermera et vous serez redirigé vers WordPress.com. Le ou les dépôts sélectionnés doivent être listés avec le compte GitHub associé à ce dépôt :
Écran sur lequel vous sélectionnez le dépôt à déployer.
  1. Cliquez sur Sélectionner en regard du dépôt à connecter.

À ce stade, vous devriez voir WordPress.com pour les développeurs sous vos applications GitHub autorisées et les applications GitHub installées.

Gérer les réglages de déploiement

Une fois que vous aurez sélectionné un dépôt, vous devrez ajuster les réglages de déploiement :

  • Branche de déploiement : par défaut, la branche par défaut du dépôt (généralement, la branche principale) peut être remplacée par la branche que vous souhaitez utiliser.
  • Répertoire de destination : dossier du serveur où vous souhaitez déployer les fichiers. Pour les extensions, il s’agira de /wp-content/plugins/my-plugin-name. Pour les thèmes, il s’agira de /wp-content/themes/my-theme-name. Pour un déploiement partiel du site (c.-à-d. plusieurs extensions ou thèmes), vous pouvez utiliser /wp-content. Le contenu d’un dépôt sera fusionné avec le contenu existant du site WordPress dans le répertoire spécifié.
  • Déploiements automatiques : il existe deux façons de déployer sur WordPress.com :
    • Automatique : une fois le code validé, il sera déployé sur votre site WordPress.com. Les déploiements automatiques sont recommandés pour les sites de préproduction.
    • Manuel : le code sera déployé une fois que vous aurez demandé un déploiement. Les déploiements manuels sont recommandés pour les sites de production.
  • Mode de déploiement : il existe deux types de déploiement :
    • Simple : ce mode copie tous les fichiers d’une branche du dépôt vers le site et les déploie sans post-traitement.
    • Avancé : ce mode vous permet d’utiliser un script de flux de travail, ce qui active des étapes de construction personnalisées, telles que l’installation des dépendances de Composer, la réalisation de tests de code avant déploiement et le contrôle du déploiement de fichiers. Idéal pour les dépôts qui nécessitent le logiciel Composer ou Node. Voir Déploiement avancé ci-dessous pour plus d’informations.

Une fois tous les réglages configurés, cliquez sur le bouton Connecter. Votre dépôt sera ajouté :

Capture d’écran affichant tous les dépôts connectés.

Notez que vous devez déclencher le premier déploiement, automatiquement ou manuellement. Vous pouvez ensuite connecter un autre dépôt à tout moment en cliquant sur le bouton « Connecter le dépôt ».

Déploiement avancé

Avec le déploiement avancé, vous pouvez fournir un script de flux de travail pour traiter les fichiers dans votre dépôt avant le déploiement. Cela ouvre de nombreuses possibilités, comme vérifier votre code pour s’assurer qu’il répond aux normes de codage de votre équipe, exécuter des tests unitaires, exclure des fichiers du déploiement, installer des dépendances, et bien plus encore. Pour commencer, consultez nos recettes de flux de travail.

Pour configurer le déploiement avancé :

  1. Un formulaire s’affiche pour configurer le déploiement.
  2. Cliquez sur le nom du dépôt pour gérer la connexion.
  3. Sur le côté droit, sous « Choisir votre mode de déploiement », choisissez Avancé.
Capture d’écran montrant comment connecter un dépôt et les nombreuses options disponibles.
  1. Si le dépôt contient déjà un fichier de flux de travail, vous pouvez le sélectionner ici. Le système vérifie le fichier pour détecter d’éventuelles erreurs. Si aucune erreur n’est détectée, passez à l’étape 7.
  2. Vous pouvez également sélectionner l’option « Créer un flux de travail » pour ajouter un fichier de flux de travail préconfiguré. Choisir cette option écrase le fichier de flux de travail wpcom.yml s’il existe déjà dans votre dépôt.
  3. Cliquez sur le bouton « Installer le flux de travail pour moi » pour valider le fichier de flux de travail dans le dépôt.
  4. Une fois qu’un flux de travail a été ajouté et vérifié, cliquez sur Mettre à jour. Votre dépôt va maintenant utiliser le déploiement avancé.

Déployer votre code

Après avoir connecté votre dépôt GitHub à un site, l’étape suivante consiste à déployer votre code. Deux méthodes de déploiement sont disponibles : Automatique et Manuel.

Les déploiements automatiques ne sont pas recommandés pour les sites de production en direct, car toute modification de code dans le dépôt est automatiquement déployée de GitHub vers le site en direct. Pensez plutôt à configurer un déploiement automatique sur un site de préproduction et à le synchroniser avec la production une fois que vous serez prêt(e).

Les déploiements manuels vous donnent plus de contrôle sur le moment où les modifications de votre code sont transmises en direct, car vous devez déclencher manuellement chaque déploiement. Nous recommandons les déploiements manuels si vous ne souhaitez pas utiliser de site de préproduction.

Pour déclencher le déploiement manuel :

  1. Visitez votre page Sites : https://wordpress.com/sites
  2. Cliquez sur le nom de votre site pour voir l’aperçu du site.
  3. Cliquez sur l’onglet Déploiements.
  4. Cliquez sur le menu à trois points (⋮) sur le dépôt que vous souhaitez déployer.
  5. Cliquez sur « Déclencher le déploiement manuel ». Vous devriez voir une bannière de notification indiquant « Exécution du déploiement créée » et l’état du déploiement passe à « En file d’attente ».
  6. Attendez la fin du déploiement (l’état passe à « Déployé »).
Capture d’écran représentant la fenêtre contextuelle de l’onglet Déploiements qui vous permet de déclencher un déploiement manuel.
  1. Cliquez à nouveau sur le menu à trois points (⋮) et choisissez « Voir les exécutions de déploiement ». 
  2. Le journal d’exécution de déploiement affiche l’auteur et la validation déployée. Si vous cliquez sur l’entrée de l’exécution de déploiement, des informations supplémentaires s’affichent.

Gérer les connexions existantes

Pour gérer vos connexions existantes au dépôt GitHub :

  1. Visitez votre page Sites : https://wordpress.com/sites
  2. Cliquez sur le nom de votre site pour voir l’aperçu du site.
  3. Cliquez sur l’onglet Déploiements.
  4. Vous devriez alors voir la liste des connexions. 

La liste des connexions s’affiche s’il existe au moins une connexion entre un dépôt GitHub et votre site. La liste comprend des informations pertinentes pour chaque connexion, telles que le nom et la branche du dépôt, la dernière validation déployée sur un site, le moment où elle s’est produite, où le code a été placé, la durée du déploiement et son état.

D’autres actions sont disponibles après un clic sur le menu à trois points (⋮) :

Capture d’écran représentant l’onglet Déploiements et la fenêtre contextuelle qui vous permet d’effectuer diverses actions sur un dépôt connecté.

Journaux d’exécution de déploiement

Les journaux d’exécution de déploiement fournissent un enregistrement détaillé et étape par étape de chaque déploiement, qu’il soit déclenché automatiquement ou manuellement. Ces journaux vous permettent de suivre les modifications, de surveiller l’état du déploiement et de résoudre les problèmes qui surviennent. Grâce à l’accès aux journaux des 10 dernières exécutions dans les 30 jours, vous pouvez facilement examiner ce qui s’est passé pendant chaque déploiement et vous assurer que tout se passe bien.

Pour vérifier les journaux d’un déploiement :

  1. Visitez votre page Sites : https://wordpress.com/sites
  2. Cliquez sur le nom de votre site pour voir l’aperçu du site.
  3. Cliquez sur l’onglet Déploiements.
  4. Cliquez sur le menu à trois points (⋮) en regard du dépôt pour lequel vous souhaitez afficher les journaux.
  5. Sélectionnez « Voir les exécutions de déploiement ».
  6. La vue en liste Exécutions de déploiement affiche les validations qui ont été déployées sur le site, l’état, la date et la durée du déploiement.
  7. Cliquez n’importe où sur une exécution pour développer et afficher des informations supplémentaires sur le déploiement.
Capture d’écran représentant l’onglet Déploiements et les exécutions de déploiement pour le dépôt sélectionné.

Les journaux fournissent un enregistrement de toutes les commandes exécutées, de l’extraction du code de GitHub à son placement dans le répertoire cible. Vous pouvez développer les lignes de journal pour voir plus d’informations en cliquant sur « Afficher plus ».

Déconnecter un dépôt

Lorsque vous déconnectez un dépôt GitHub de votre site, toute modification future apportée au dépôt n’a plus d’impact sur votre site. Par défaut, les fichiers déployés restent sur votre site, mais vous avez la possibilité de les supprimer pendant le processus de déconnexion.

Pour supprimer un dépôt :

  1. Visitez votre page Sites : https://wordpress.com/sites
  2. Cliquez sur le nom de votre site pour voir l’aperçu du site.
  3. Cliquez sur l’onglet Déploiements.
  4. Cliquez sur le menu à trois points (⋮) dans le dépôt.
  5. Sélectionnez « Déconnecter le dépôt ».
  6. Une fenêtre de dialogue s’affiche. Cliquez sur le commutateur pour supprimer les fichiers associés du site.
  7. Cliquez sur « Déconnecter le dépôt » pour fermer la boîte de dialogue et déconnecter le dépôt.
Capture d’écran illustrant la boîte de dialogue de déconnexion d’un dépôt.

Notez que WordPress.com pour les développeurs apparaîtra toujours dans vos applications GitHub installées et vos applications GitHub autorisées. En effet, WordPress.com a toujours accès au dépôt, mais la connexion a été supprimée.

Déconnecter WordPress.com de GitHub

Vous pouvez également choisir de révoquer l’accès de WordPress.com à votre compte GitHub. Vous pouvez le faire à tout moment en accédant à vos réglages Applications sur GitHub. 

Pour révoquer l’accès autorisé de l’application à votre compte GitHub :

  1. Accédez à Applications GitHub autorisées.
  2. Cliquez sur Révoquer en regard de WordPress.com pour les développeurs.
  3. Cliquez sur le bouton « Je comprends, révoquer l’accès ».

Même si vous révoquez l’accès autorisé à l’application, le code peut toujours être déployé, car l’application WordPress.com pour les développeurs reste installée sur les comptes sélectionnés.

Pour révoquer l’accès à l’installation WordPress.com et désactiver la possibilité de déployer du code sur votre site WordPress.com :

  1. Accédez à Applications GitHub installées.
  2. Cliquez sur Configurer en regard de WordPress.com pour les développeurs.
  3. Dans la zone Zone de danger, cliquez sur Désinstaller, puis sur OK lorsque vous y serez invité.

Retirer WordPress.com de la liste des applications autorisées ne signifie pas que les dépôts seront supprimés ou cesseront de fonctionner. Vos dépôts existeront toujours sur GitHub après que vous aurez révoqué l’accès de WordPress.com, mais WordPress.com ne pourra plus déployer de code.

Copied to clipboard!