Découvrez comment collaborer depuis RoboHelp à l’aide de Git.

Prérequis pour la connexion à Git

  1. Téléchargez et installez Git sur votre système. Cliquez ici pour télécharger Git pour Windows. Pour plus d’informations, reportez-vous à l’aide de Git

  2. Ajustez votre variable d’environnement CHEMIN pour pouvoir utiliser Git ainsi que les outils UNIX facultatifs à partir de l’invite de commande Windows. Pour cela, sélectionnez cette option dans le programme d’installation de Git :

    Écran d’installation de Git

    Votre variable d’environnement CHEMIN doit contenir cette valeur :

    C:\Program Files\Git\usr\bin

    Variable de chemin Git

    Remarque :

    À partir de la version 1803 de Windows 10, Microsoft a ajouté la prise en charge native de SSH, qui est connue pour provoquer des conflits avec les connexions Git. Si votre version de Windows est ultérieure à 1803, assurez-vous que le chemin vers les fichiers binaires SSH dans l’installation Git (C:\Program Files\Git\usr\bin) a la priorité sur le chemin vers les fichiers binaires SSH fournis par Microsoft (%SystemRoot%\system32). Vous pouvez accéder à la variable d’environnement CHEMIN du système grâce à la boîte de dialogue Propriétés système > ongletAvancé > Variables d’environnement.

  3. Enregistrez votre application de diffusion/fusion externe dans RoboHelp. Pour effectuer cette action :

    1. Choisissez Édition > Préférences

    2. Dans la boîte de dialogue Paramètres d’application, cliquez sur l’onglet Contrôle de version

    3. Dans le champ Application de diffusion/fusion externe, cliquez sur  pour sélectionner votre application de diffusion/fusion externe, comme par exemple p4merge.

      Vérifiez que Git prend en charge votre application en exécutant la commande suivante dans l’invite de commande :

      git mergetool --tool-help

    4. Cliquez sur Terminé.

Création d’un profil de connexion Git

Créez un profil de connexion Git pour connecter RoboHelp avec Git.

  1. Votre serveur Git doit contenir un référentiel auquel vous pouvez vous connecter à partir de RoboHelp. Pour créer un référentiel, suivez les instructions de GitHub, Bitbucket ou celles de votre fournisseur d’hébergement Git.

    Remarque :

    Si vous souhaitez utiliser le profil de connexion pour télécharger le projet RoboHelp actuellement ouvert sur votre serveur Git, l’URL du nouveau référentiel doit être vide. Lors de la création du référentiel, veillez à ne pas l’initialiser avec un fichier Lisez-Moi.  

  2. Dans RoboHelp, sélectionnez Collaboration > Nouvelle connexion.

  3. Dans la boîte de dialogue Profils de connexion, indiquez un nom pour votre profil de connexion.

  4. Dans la liste déroulante Contrôle de version, sélectionnez Git.

  5. Dans le champ URL SSH du référentiel, indiquez l’URL SSH du référentiel dans l’un des formats suivants :

    • git@<nomduserveur>:<nomOrg/nomRéférentiel>.git 
    • ssh://git@<nomduserveur>/<nomOrg/nomRéférentiel>.git

    Par exemple, git@github.com:adobe/brackets.git ou ssh://git@github.com/adobe/brackets.git.

  6. Dans le champ ID utilisateur, indiquez le nom du compte d’utilisateur qui dispose d’un accès en lecture/écriture au référentiel Git spécifié.

  7. Dans le champ Branche, indiquez le nom de la branche sur le serveur. Le nom de branche par défaut est maître.

  8. Dans le champ Clé privée SSH, indiquez ou accédez au chemin d’accès de la clé privée SSH que vous utilisez pour vous connecter au référentiel sur votre serveur Git. Pour créer une nouvelle connexion SSH à votre serveur Git, voir l’article Configuration d’une connexion SSH

    Remarque :

    Si la clé SSH spécifiée contient une phrase secrète, RoboHelp vous invite à la saisir et l’enregistre dans le Gestionnaire d’informations d’identification pour une utilisation ultérieure. L’enregistrement est stocké dans ce format :
    git@<nomduserveur>:<nomOrg/nomRéférentiel>/<utilisateur>
    Si vous utilisez une nouvelle clé SSH pour la connexion au même référentiel, mais avec une phrase secrète différente, supprimez ou mettez à jour l’enregistrement correspondant dans le Gestionnaire d’informations d’identification du système. Si RoboHelp ne trouve pas d’enregistrement correspondant dans le Gestionnaire d’informations d’identification, il demande à nouveau la phrase secrète. Pour plus d’ informations sur le Gestionnaire d’informations d’identification du système (Windows), consultez l’aide de Microsoft.

    Si la clé est correctement ajoutée à l’agent SSH en cours d’exécution sur votre système et que la connexion au serveur Git spécifié a réussi à l’aide de cette clé, une invite de confirmation apparaît. Le bouton Enregistrer est activé uniquement si cette étape est réussie. Dans le cas contraire, vérifiez la configuration de la connexion en vous référant à l’article Configuration d’une connexion SSH.

  9. Dans le champ Chemin local, indiquez un chemin sur votre ordinateur qui mappe vers le référentiel sur le serveur.

    Si vous souhaitez utiliser le profil de connexion pour télécharger le projet RoboHelp actuellement ouvert sur votre serveur Git, spécifiez le dossier contenant le projet ou l’un de ses dossiers parents. Le référentiel Git local est initialisé dans ce dossier et publié sur votre serveur Git. 

    Sinon, pour utiliser le profil de connexion pour cloner un référentiel depuis votre serveur Git, indiquez le chemin d’accès vers un dossier local vide dans lequel le référentiel doit être cloné. Si le chemin spécifié n’existe pas, il est créé avant le clonage.

  10. Cliquez sur Enregistrer.

Configuration d’une connexion SSH

  1. Créez une paire de clés SSH (publique et privée) à l’aide de GitBash. Pour plus d’informations, reportez-vous à l’aide de Git

  2. Ajoutez la nouvelle clé publique SSH à votre compte sur votre serveur Git en suivant les instructions de GitHubBitbucket ou celles de votre fournisseur d’hébergement Git.

  3. Testez la connexion à votre serveur Git à l’aide de la paire de clés SSH en suivant les instructions de GitHub, Bitbucket ou celles de votre fournisseur d’hébergement Git. Connectez-vous au serveur Git spécifié via SSH à l’aide de la commande suivante sur le terminal :
    $ ssh -T git@<nomduserveur>

    Remarque :

    Vous devrez peut-être spécifier des arguments supplémentaires si votre serveur Git utilise un port pour les connexions SSH différent du port par défaut (22). Par exemple, ajoutez l’option -p <numérodeport> pour spécifier le numéro de port SSH alternatif.

    Assurez-vous que les connexions SSH ne sont pas bloquées par votre pare-feu. La connexion Git via RoboHelp n’aboutit que si cette étape est réussie.

 

 

Clonage d’un projet depuis votre serveur Git

  1. Dans RoboHelp, sélectionnez Collaborer > Ouvrir une connexion puis sélectionnez un profil de connexion Git. Le référentiel est cloné sur le chemin d’accès local spécifié dans le profil de connexion.

    Remarque :

    Si le chemin local spécifié dans le profil de connexion contient déjà un référentiel Git, le clonage n’aura pas lieu.

  2. Dans la boîte de dialogue Ouvrir, sélectionnez un fichier projet RoboHelp (.rhpj), puis cliquez sur Ouvrir.

    RoboHelp ouvre le fichier projet.  

    Remarque :

    Lorsque vous ouvrez un projet RoboHelp pour la première fois à l’aide de ces étapes, les informations de connexion sont stockées dans le projet pour une utilisation ultérieure. Vous pouvez ainsi ouvrir directement le projet à l’aide de l’un des moyens décrits dans la section Ouverture d’un projet

Utilisation des fichiers sous contrôle de version

Ajout de contenu ou modification d’une rubrique. Vous pouvez rapidement éditer des fichiers sans connexion réseau. 

Vous pouvez également effectuer les opérations suivantes :

Validation de vos modifications

  1. Pour valider les modifications dans votre référentiel local, sélectionnez Collaborer > Valider

    La boîte de dialogue Validers’ouvre.

  2. Dans la boîte de dialogue Valider, sélectionnez les fichiers que vous souhaitez valider dans la liste des fichiers modifiés, ajoutés ou supprimés.

  3. Spécifiez une description de validation pour pouvoir valider les modifications. 

  4. Cliquez sur Valider

    Lorsque la validation est réussie, RoboHelp affiche un message de réussite.

Exécution d’une transmission de type push de vos modifications vers le serveur

Pour effectuer une transmission de type push des modifications en attente vers votre serveur Git, sélectionnez Collaborer > Push

Si un autre utilisateur a mis à jour le référentiel sur votre serveur Git, la transmission de type push échoue. Dans ce cas, extrayez la dernière version du référentiel depuis le serveur, puis recommencez la transmission de type push.

Remarque :

Pour effectuer cette opération, vous devez avoir un accès en écriture au référentiel sur votre serveur Git.

Extraction des dernières versions du serveur

  1. Pour synchroniser votre référentiel local afin qu’il corresponde au référentiel sur le serveur, sélectionnez Collaborer > Pull.

    Si certains de vos fichiers locaux contiennent des modifications qui n’ont pas encore été validées dans votre référentiel local et que ces fichiers sont mis à jour sur le serveur, l’opération d’extraction échoue. Dans ce cas, commencez par valider vos modifications

  2. Après l’extraction des modifications, les fichiers contenant des validations locales et distantes sont fusionnés. Si la fusion échoue, il convient de résoudre le conflit de fusion qui s’est produit. Pour résoudre les conflits de fusion, sélectionnez Collaborer > Valider.

    Dans la boîte de dialogue Valider, les fichiers contenant des conflits de fusion sont indiqués comme  dans la colonne Action.

  3. Cliquez sur  en regard du fichier pour fusionner les conflits à l’aide de l’application de diffusion/fusion externe que vous avez enregistrée à l’étape 3 de la section Prérequis pour la connexion à Git.

    L’application de diffusion/fusion enregistrée s’ouvre pour le fichier spécifique. 

  4. Résolvez les conflits et fermez l’application de diffusion/fusion.

  5. Validez les fichiers résolus en cliquant sur Valider dans la boîte de dialogue Valider.

Ajout d’un projet à votre serveur Git

  1. Pour ajouter un projet, sélectionnez Collaborer > Ajouter un projet puis sélectionnez un profil de connexion Git.

    Le chemin d’accès local du profil doit contenir le projet en cours. Pour plus d’informations, consultez l’étape 9 de la section Création d’un profil de connexion Git.  

    Remarque :

    Cette opération échoue si le référentiel spécifié dans le profil de connexion contient des fichiers. Pour ajouter votre projet RoboHelp à un référentiel existant sur le serveur, commencez par cloner ce référentiel sur votre système, puis copiez ou déplacez votre projet dans le dossier dans lequel le référentiel a été cloné.

    La boîte de dialogue Valider s’ouvre.

  2. Validez les fichiers requis comme indiqué dans la section Validation de vos modifications

  3. Effectuez une transmission de type push de vos modifications, comme indiqué dans la section Exécution d’une transmission de type push de vos modifications vers le serveur

Suppression de la connexion Git

  1. Pour supprimer la connexion Git du projet RoboHelp en cours, sélectionnez Collaborer > Supprimer la connexion.

  2. Si vous souhaitez également supprimer le référentiel local, sélectionnez le champ Supprimer toute information de contrôle source du dossier local dans la boîte de dialogue Confirmer

    Attention :

    Validez et transmettez toutes vos modifications avant de supprimer le référentiel.

  3. Cliquez sur OK.

    Lorsque la connexion est supprimée, RoboHelp ouvre à nouveau le projet et l’option Ajouter un projet du menu Collaborer devient disponible. Pour ajouter à nouveau le projet, consultez la section Ajout d’un projet à votre serveur Git.

    Remarque :

    Si vous n’avez pas supprimé le référentiel local, lorsque vous ajoutez le projet en utilisant le même profil de connexion qu’auparavant, vos modifications locales sont conservées et vous pouvez les valider ou les transmettre selon les besoins. 

    Si vous avez supprimé le référentiel local, vous ne pouvez pas transmettre les modifications appliquées au référentiel vers le serveur mentionné dans le même profil de connexion car il contient déjà des fichiers. Vous devez donc ajouter le projet à l’aide d’un profil de connexion contenant un référentiel vide.

Ce produit est distribué sous licence Creative Commons Attribution - Pas d’utilisation commerciale - Partage à l’identique 3.0 non transposé  Les publications Twitter™ et Facebook ne sont pas couvertes par les dispositions Creative Commons.

Mentions légales   |   Politique de confidentialité en ligne