PRé-REQUIS

Le côté peu commun de la fonctionnalité nécessite de respecter certaines règles qui n’ont cependant rien de bloquant :

• Un thème ne peut être représenté que par un seul dépôt git et un dépôt git ne peut contenir qu’un seul thème.
  Exemple : Un thème ne peut donc pas avoir ses css sur un dépôt, et ses js sur un autre.
• Un dépôt ne contient les fichiers que d’un unique thème.
• Seule la branche master est prise en compte et mise à jour sur le serveur pour le moment.
• Le répertoire du dépôt correspond au répertoire du thème.
  On s’attend donc à avoir directement à la racine du dépôt les répertoires “css”, “js”, “img”, etc.
• Le dépôt doit obligatoirement être disponible via https

Quelques conseils :

• Si le dépôt est privé, il sera protégé par un couple identifiant/mot de passe. Il est conseillé de créer un compte spécifique pour la plateforme Comexposium, ayant les droits de lecture sur le dépôt.

LE CMS

La gestion des thèmes se fait via des objets eZPublish de la classe “Thème git” dans le groupe “Salons”. Un répertoire spécial a été créé dans le backoffice pour accueillir les thèmes git : “Thèmes git” qui se trouve à la racine du contenu.

Dans ce dossier, se trouveront tous les thèmes des sites gérés depuis GIT :

Lorsque l'on cliquera sur les thèmes, nous aurons accès au paramétrage de ceux-ci :

Les attributs de la classe sont les suivants :

• Titre : il s’agit du titre du thème. Il est utilisé uniquement en affichage dans le back-office
• Nom du thème pour la config : il s’agit du nom du thème qui sera utilisé sur la plateforme, dans le répertoire des thèmes existants.
  Exemple : foiredeparis_2018_mobile.
  Le nom du thème doit être composé uniquement de lettres minuscules et du caractère “_”
• URL du dépôt : il s’agit de l’URL du dépôt, obligatoirement en https
  Exemple ci-dessus : https://github.com/comexposium/retest.git
  Autre exemple fictif : https://github.com/comexposium/theme_foiredeparis.git
  Cette adresse est celle de clonage qui est fournie par l’outil de versionning, par exemple avec Github, le bouton vert “Clone or download”
• Nom d'utilisateur : l’identifiant pour se connecter au dépôt git.
  Dans le cas d’un dépôt public, laisser cette valeur vide
• Mot de passe : le mot de passe associé au nom d’utilisateur.
  Dans le cas d’un dépôt public, laisser cette valeur vide

A la création d’un objet, aucune action n’est réalisée sur le serveur. Un nouveau bouton apparaît en backoffice pour les thèmes git : “Mettre à jour”. C'est ce bouton qui branchera les ressources GIT au site web en question.

MISES à JOUR

Le clic sur le bouton “Mettre à jour” a deux actions en fonction de l’état du dépôt sur le serveur :

• Si le dépôt n’existe pas, il va tenter de créer une copie sur le serveur
• Si le dépôt existe, il va mettre à jour le code depuis la source distante

Après avoir cliqué, nous serons redirigés vers une page qui indique le bon déroulé des opérations.

Voici une liste des vérifications effectuées par l’action du bouton. Chaque vérification peut afficher une erreur sur l’écran récapitulatif. Les erreurs traitées sont affichées en français et sont suivies du retour brut de la commande afin d’aider au debug si nécessaire.

• Tentative de connexion au serveur du dépôt, afin de vérifier la configuration réseau
• Vérification de l’existence du répertoire destination (= répertoire des thèmes)
• Vérification de la possibilité de créer le répertoire du nouveau thème
• Tentative de clonage du dépôt
• Vérification que le nom du thème correspond à un thème existant et que l’URL du dépôt est la même.
  Cette vérification permet d’éviter d’avoir 2 dépôts qui pointent vers le même thème
• Tentative de mise à jour du code source

D’autres erreurs pourraient s’afficher. Dans tous les cas, récupérer le texte et transmettre l'erreur via un ticket Jira.

Que l’action ait fonctionné sans problème ou qu’une erreur se soit produite, un bouton “Retour” permet de revenir au thème.

KLOUDSPEAKER TO GIT

Ayant maintenant la main sur le siteaccess du CMS, nous pouvons modifier directement le thème pour switcher de KS vers GIT grâce à l'objet Ez "configuration du siteaccess".

Cela dit, pour passer vers GIT un site qui est actuellement mis à jour via Kloudspeaker, deux méthodes sont possibles :

• Passer par Kloudspeaker pour supprimer le répertoire (il est conseillé de faire une copie de sauvegarde avant) et créer ensuite le thème git avec le même nom
• Créer un thème git avec un nom de thème différent du nom du thème en place + modifier la config du siteaccess pour utiliser le nouveau nom
  
  Exemple : le thème foire_de_paris est en place et est mis à jour via Kloudspeaker.
  Je veux le passer sur git.
  Je crée un dépôt, récupère les fichiers du thème en place et les commit sur le dépôt. Ensuite, je crée un objet "thème git" dans le backoffice et je lui mets comme nom "foire_de_paris_git" (ou "foire_de_paris_2018", il faut simplement qu'il soit différent du premier). Une fois l'ajout effectué, je modifie la config du siteaccess pour enfin utiliser le nouveau nom du thème

FAQ