Concepts Git fondamentaux
Repository
Repository
La source de votre documentation où tous les fichiers et leur historique sont stockés. L’Éditeur web se connecte à votre repository pour accéder au contenu et le modifier.
Commit
Commit
Une capture enregistrée de vos modifications à un moment donné. Chaque commit inclut un message décrivant ce qui a changé et crée une trace permanente dans l’historique de votre projet.
Branch
Branch
Une branche pointe vers un commit spécifique dans votre repository. Votre documentation en ligne est générée à partir d’une branche de déploiement. Vous pouvez avoir autant d’autres branches que nécessaire, avec des modifications qui ne sont pas encore publiées sur votre documentation en ligne. Si vous souhaitez intégrer les modifications d’une branche à votre documentation en ligne, vous pouvez fusionner cette branche dans votre branche de déploiement via une pull request.Utilisez les branches pour travailler sur des changements sans impacter votre documentation en ligne, expérimenter en toute sécurité de nouvelles fonctionnalités et obtenir des relectures avant publication.
Deployment branch
Deployment branch
La branche principale de votre projet à partir de laquelle le contenu de votre documentation en ligne est généré. Les modifications apportées à cette branche sont automatiquement publiées sur votre site de documentation. Souvent appelée
main
, mais vous pouvez définir n’importe quelle branche comme branche de déploiement.Pull request
Pull request
Un moyen de proposer la fusion de vos modifications d’une branche dans votre documentation en ligne. Permet la relecture et la discussion avant la mise en ligne des changements. Couramment appelée PR, également appelée merge request dans GitLab.
Diff
Diff
Un diff (ou différence) montre les modifications entre deux versions d’un fichier. Lors de la relecture des pull requests, les diffs mettent en évidence ce qui a été ajouté, supprimé ou modifié, ce qui facilite l’identification des changements.
Comment l’Éditeur web utilise Git
L’Éditeur web se connecte à votre dépôt Git via l’application GitHub ou l’intégration GitLab et automatise les opérations Git courantes. Lorsque vous :- Ouvrez un fichier : l’éditeur récupère la dernière version depuis votre dépôt, pour vous assurer de travailler toujours avec un contenu à jour.
- Apportez des modifications : l’éditeur suit vos changements en tant que brouillon, qui peut devenir un commit lorsque vous êtes prêt à enregistrer votre travail.
- Enregistrez des modifications : l’éditeur crée un commit avec vos changements, préservant votre travail dans l’historique du projet.
- Créez une branche : l’éditeur crée une nouvelle branche dans votre dépôt, utilisable par toute personne ayant accès au dépôt pour collaborer et relire les changements.
- Publiez sur votre branche de déploiement : l’éditeur crée un commit et pousse directement sur votre branche de déploiement, ce qui publie vos modifications immédiatement.
- Publiez sur d’autres branches : l’éditeur ouvre une pull request, ce qui vous permet d’obtenir des retours avant de fusionner vos modifications dans votre branche de déploiement.
Bonnes pratiques Git
- Rédigez des messages de commit descriptifs : soyez précis sur ce qui a changé en utilisant une formulation active.
- Utilisez des noms de branches explicites : les noms de branches doivent décrire le travail effectué et être parlants pour quelqu’un qui consulte les branches de votre dépôt.
- Gardez les branches focalisées : limitez les changements sur une branche à une tâche ou un projet spécifique.
- Supprimez les branches après la fusion : supprimez les branches dont vous n’avez plus besoin pour garder votre dépôt propre.