Dans la mesure où il peut y avoir différents workflows possibles, il peut s'avérer difficile de savoir quand commencer l'implémentation de Git sur le lieu de travail. Cette page pose les bases en examinant les workflows Git les plus courants pour les équipes professionnelles.

Lorsque vous la lirez, gardez à l'esprit que ces workflows sont conçus pour servir de références et ne constituent pas des règles concrètes. Nous voulons vous montrer ce qui est possible. Vous pouvez donc combiner différents workflows pour répondre à vos besoins spécifiques.

Workflow centralisé

Workflows Git : Workflow de type SVN

Transitioning to a distributed version control system may seem like a daunting task, but you don’t have to change your existing workflow to take advantage of Git. Your team can develop projects in the exact same way as they do with Subversion.

However, using Git to power your development workflow presents a few advantages over SVN. First, it gives every developer their own local copy of the entire project. This isolated environment lets each developer work independently of all other changes to a project—they can add commits to their local repository and completely forget about upstream developments until it's convenient for them.

En second lieu, vous avez accès au puissant modèle de merging et de branching de Git. Contrairement à SVN, les branches Git sont conçues comme un mécanisme de sécurité pour l'intégration du code et le partage des changements entre les dépôts.

Fonctionnement

Like Subversion, the Centralized Workflow uses a central repository to serve as the single point-of-entry for all changes to the project. Instead of trunk, the default development branch is called master and all changes are committed into this branch. This workflow doesn’t require any other branches besides master.

Developers start by cloning the central repository. In their own local copies of the project, they edit files and commit changes as they would with SVN; however, these new commits are stored locally—they’re completely isolated from the central repository. This lets developers defer synchronizing upstream until they’re at a convenient break point.

To publish changes to the official project, developers “push” their local master branch to the central repository. This is the equivalent of svn commit, except that it adds all of the local commits that aren’t already in the central master branch.

Dépôt central et dépôts locaux

Gestion des conflits

Le dépôt centralisé représente le projet officiel. L'historique des commits doit donc être considéré comme sacré et immuable. Si les commits locaux d'un développeur diffèrent du dépôt centralisé, Git refusera de pusher les changements, car cela écraserait les commits officiels.

Gestion des conflits

Dans la mesure où les développeurs peuvent publier leur fonctionnalité, ils doivent fetcher les commits centraux mis à jour et rebaser leurs changements sur ces commits. Cela revient à dire : « Je veux ajouter mes modifications à tout ce qui été fait par les autres ». Résultat : un historique parfaitement linéaire, comme dans les workflows SVN traditionnels.

If local changes directly conflict with upstream commits, Git will pause the rebasing process and give you a chance to manually resolve the conflicts. The nice thing about Git is that it uses the same git status and git add commands for both generating commits and resolving merge conflicts. This makes it easy for new developers to manage their own merges. Plus, if they get themselves into trouble, Git makes it very easy to abort the entire rebase and try again (or go find help).

Exemple

Examinons étape par étape comment une petite équipe peut collaborer en utilisant ce workflow. Nous verrons comment deux développeurs, Jean et Marie, peuvent travailler sur des fonctionnalités distinctes et partager leurs contributions via un dépôt centralisé.

Un utilisateur initialise le dépôt centralisé

Worklows Git : Initialiser le dépôt centralisé brut

En premier lieu, un utilisateur doit créer le dépôt centralisé sur un serveur. S'il s'agit d'un nouveau projet, vous pouvez initialiser un dépôt vide. Sinon, vous devez importer un dépôt Git ou SVN existant.

Les dépôts centraux doivent toujours être des dépôts bruts (ils ne doivent pas avoir de répertoire de travail) qui peuvent être créés comme suit :

ssh user@host git init --bare /path/to/repo.git

Be sure to use a valid SSH username for user, the domain or IP address of your server for host, and the location where you'd like to store your repo for /path/to/repo.git. Note that the .git extension is conventionally appended to the repository name to indicate that it’s a bare repository.

Tout le monde clone le dépôt centralisé

Workflows Git : Cloner le dépôt centralisé

Next, each developer creates a local copy of the entire project. This is accomplished via the git clone command:

git clone ssh://user@host/path/to/repo.git

When you clone a repository, Git automatically adds a shortcut called origin that points back to the “parent” repository, under the assumption that you'll want to interact with it further on down the road.

Jean travaille sur sa fonctionnalité

Workflows Git : Process d'édition, de staging et de commit de fonctionnalité

Dans son dépôt local, Jean peut développer des fonctionnalités à l'aide du process de commit Git standard : édition, staging et commit. La zone de staging vise à préparer un commit sans avoir à inclure chaque changement dans le répertoire de travail. Ainsi, vous pouvez créer des commits très ciblés, même si vous avez effectué un grand nombre de changements locaux.

git status # View the state of the repo
git add <some-file> # Stage a file
git commit # Commit a file</some-file>

N'oubliez pas que puisque ces commandes créent des commits locaux, Jean peut répéter ce process autant de fois qu'il le souhaite sans avoir à se soucier de ce qu'il se passe dans le dépôt centralisé. Cela peut s'avérer très utile pour les fonctionnalités volumineuses qui nécessitent d'être divisées en blocs plus simples.

Marie travaille sur sa fonctionnalité

Workflows Git : Process d'édition, de staging et de commit de fonctionnalité

Meanwhile, Mary is working on her own feature in her own local repository using the same edit/stage/commit process. Like John, she doesn’t care what’s going on in the central repository, and she really doesn’t care what John is doing in his local repository, since all local repositories are private.

Jean publie sa fonctionnalité

Workflows Git : Publier une fonctionnalité

Once John finishes his feature, he should publish his local commits to the central repository so other team members can access it. He can do this with the git push command, like so:

git push origin master

Remember that origin is the remote connection to the central repository that Git created when John cloned it. The master argument tells Git to try to make the origin’s master branch look like his local master branch. Since the central repository hasn’t been updated since John cloned it, this won’t result in any conflicts and the push will work as expected.

Marie tente de publier sa fonctionnalité

Workflows Git : Erreur de commande push

Voyons ce qu'il se passe si Marie tente de pusher sa fonctionnalité après que Jean a publié ses changements dans le dépôt centralisé. Elle peut utiliser la même commande push :

git push origin master

Mais comme son historique local diverge du dépôt centralisé, Git refusera la requête et renverra un message d'erreur détaillé :

error: failed to push some refs to '/path/to/repo.git'
hint: Updates were rejected because the tip of your current branch is behind
hint: its remote counterpart. Merge the remote changes (e.g. 'git pull')
hint: before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.

Cela empêche Marie d'écraser les commits officiels. Elle doit faire un pull des mises à jour de Jean dans son dépôt, les intégrer avec ses changements locaux, puis réessayer.

Marie fait un rebase par-dessus le ou les commits de Jean

Workflows Git : git pull -- rebase

Mary can use git pull to incorporate upstream changes into her repository. This command is sort of like svn update—it pulls the entire upstream commit history into Mary’s local repository and tries to integrate it with her local commits:

git pull --rebase origin master

The --rebase option tells Git to move all of Mary’s commits to the tip of the master branch after synchronising it with the changes from the central repository, as shown below:

Faire un rebase sur le master

Le pull fonctionnera toujours si vous oubliez cette option, mais vous vous retrouverez avec un commit de merge superflu à chaque fois qu'un utilisateur devra synchroniser son dépôt avec le dépôt centralisé. Pour ce workflow, il est toujours préférable de procéder à un rebase plutôt que de générer un commit de merge.

Marie résout un conflit de merge

Workflows Git : Rebase sur des commits

Rebasing works by transferring each local commit to the updated master branch one at a time. This means that you catch merge conflicts on a commit-by-commit basis rather than resolving all of them in one massive merge commit. This keeps your commits as focused as possible and makes for a clean project history. In turn, this makes it much easier to figure out where bugs were introduced and, if necessary, to roll back changes with minimal impact on the project.

Si Marie et Jean travaillent sur des fonctionnalités non liées, il est peu probable que le process de rebase génère des conflits. Si c'est le cas, Git interrompt le rebase au commit actuel et affiche le message suivant avec des instructions pertinentes associées :

CONFLICT (content): Merge conflict in <nom-fichier>
Résolution des conflits

The great thing about Git is that anyone can resolve their own merge conflicts. In our example, Mary would simply run a git status to see where the problem is. Conflicted files will appear in the Unmerged paths section:

# Unmerged paths:
# (use "git reset HEAD <some-file>..." to unstage)
# (use "git add/rm <some-file>..." as appropriate to mark resolution)
#
# both modified: <some-file>

Then, she’ll edit the file(s) to her liking. Once she’s happy with the result, she can stage the file(s) in the usual fashion and let git rebase do the rest:

git add <some-file>
git rebase --continue

Le tour est joué. Git passe au commit suivant et répète le process pour tous les commits qui génèrent des conflits.

If you get to this point and realize and you have no idea what’s going on, don’t panic. Just execute the following command and you’ll be right back to where you started before you ran [git pull --rebase](/tutorials/syncing/git-pull):

git rebase --abort

Marie publie avec succès sa fonctionnalité

Workflows Git : Synchroniser le dépôt centralisé

Après avoir synchronisé le dépôt centralisé, Marie pourra publier ses changements avec succès :

git push origin master

Marche à suivre

Comme vous pouvez le voir, il est possible de répliquer un environnement de développement Subversion classique avec seulement quelques commandes Git. C'est intéressant pour la migration d'équipes hors du dépôt SVN, mais cela n'exploite pas la nature distribuée de Git.

If your team is comfortable with the Centralized Workflow but wants to streamline its collaboration efforts, it's definitely worth exploring the benefits of the Feature Branch Workflow. By dedicating an isolated branch to each feature, it’s possible to initiate in-depth discussions around new additions before integrating them into the official project.

Workflow de branche par fonctionnalité

Workflow de branche par fonctionnalité

Once you've got the hang of the Centralized Workflow, adding feature branches to your development process is an easy way to encourage collaboration and streamline communication between developers.

The core idea behind the Feature Branch Workflow is that all feature development should take place in a dedicated branch instead of the master branch. This encapsulation makes it easy for multiple developers to work on a particular feature without disturbing the main codebase. It also means the master branch will never contain broken code, which is a huge advantage for continuous integration environments.

Encapsulating feature development also makes it possible to leverage pull requests, which are a way to initiate discussions around a branch. They give other developers the opportunity to sign off on a feature before it gets integrated into the official project. Or, if you get stuck in the middle of a feature, you can open a pull request asking for suggestions from your colleagues. The point is, pull requests make it incredibly easy for your team to comment on each other’s work.

Fonctionnement

The Feature Branch Workflow still uses a central repository, and master still represents the official project history. But, instead of committing directly on their local master branch, developers create a new branch every time they start work on a new feature. Feature branches should have descriptive names, like animated-menu-items or issue-#1061. The idea is to give a clear, highly-focused purpose to each branch.

Git makes no technical distinction between the master branch and feature branches, so developers can edit, stage, and commit changes to a feature branch just as they did in the Centralized Workflow.

In addition, feature branches can (and should) be pushed to the central repository. This makes it possible to share a feature with other developers without touching any official code. Since master is the only “special” branch, storing several feature branches on the central repository doesn’t pose any problems. Of course, this is also a convenient way to back up everybody’s local commits.

Pull Requests

Aside from isolating feature development, branches make it possible to discuss changes via pull requests. Once someone completes a feature, they don’t immediately merge it into master. Instead, they push the feature branch to the central server and file a pull request asking to merge their additions into master. This gives other developers an opportunity to review the changes before they become a part of the main codebase.

La revue du code est un avantage majeur des pull requests. En réalité, celles-ci sont conçues pour offrir un moyen générique de parler du code. On peut considérer les pull requests comme un espace de discussion dédié à une branche particulière. Elles peuvent donc aussi être utilisées beaucoup plus tôt dans le process de développement. Par exemple, si un développeur a besoin d'aide pour une fonctionnalité spécifique, il lui suffit de faire une pull request. Les parties intéressées seront automatiquement informées et elles pourront voir la question en regard des commits en question.

Once a pull request is accepted, the actual act of publishing a feature is much the same as in the Centralized Workflow. First, you need to make sure your local master is synchronized with the upstream master. Then, you merge the feature branch into master and push the updated master back to the central repository.

Pull requests can be facilitated by product repository management solutions like Bitbucket Cloud or Bitbucket Server. View the Bitbucket Server pull requests documentation for an example.

Exemple

L'exemple ci-dessous montre une pull request comme une revue de code, mais gardez à l'esprit que les pull requests peuvent avoir bien d'autres usages.

Marie commence une nouvelle fonctionnalité

Nouvelle branche de fonctionnalité

Before she starts developing a feature, Mary needs an isolated branch to work on. She can request a new branch with the following command:

git checkout -b marys-feature master

This checks out a branch called marys-feature based on master, and the -b flag tells Git to create the branch if it doesn’t already exist. On this branch, Mary edits, stages, and commits changes in the usual fashion, building up her feature with as many commits as necessary:

git status
git add <some-file>
git commit

Marie va déjeuner

Workflows Git : Commits de fonctionnalité

Mary adds a few commits to her feature over the course of the morning. Before she leaves for lunch, it’s a good idea to push her feature branch up to the central repository. This serves as a convenient backup, but if Mary was collaborating with other developers, this would also give them access to her initial commits.

git push -u origin marys-feature

This command pushes marys-feature to the central repository (origin), and the -u flag adds it as a remote tracking branch. After setting up the tracking branch, Mary can call git push without any parameters to push her feature.

Marie termine sa fonctionnalité

Workflows Git : Pull request

When Mary gets back from lunch, she completes her feature. Before merging it into master, she needs to file a pull request letting the rest of the team know she's done. But first, she should make sure the central repository has her most recent commits:

git push

Then, she files the pull request in her Git GUI asking to merge marys-feature into master, and team members will be notified automatically. The great thing about pull requests is that they show comments right next to their related commits, so it's easy to ask questions about specific changesets.

Guillaume reçoit la pull request

Workflows Git : Pull requests de fonctionnalité

Bill gets the pull request and takes a look at marys-feature. He decides he wants to make a few changes before integrating it into the official project, and he and Mary have some back-and-forth via the pull request.

Marie apporte les changements

Workflows Git : Faire un push vers le dépôt centralisé

Pour apporter les changements, Marie utilise le même process que celui utilisé pour créer la première itération de sa fonctionnalité. Elle édite, stage, commite et pushe les mises à jour vers le dépôt centralisé. Toutes ses activités apparaissent dans la pull request, et Guillaume peut ajouter des commentaires à tout moment.

If he wanted, Bill could pull marys-feature into his local repository and work on it on his own. Any commits he added would also show up in the pull request.

Marie publie sa fonctionnalité

Faire un merge d'une branche de fonctionnalité

Lorsque Guillaume est prêt à accepter la pull request, un utilisateur doit faire un merge de la fonctionnalité dans le projet stable (cette opération peut être exécutée par Marie ou Guillaume lui-même) :

git checkout master
git pull
git pull origin marys-feature
git push

First, whoever’s performing the merge needs to check out their master branch and make sure it’s up to date. Then, git pull origin marys-feature merges the central repository’s copy of marys-feature. You could also use a simple git merge marys-feature, but the command shown above makes sure you’re always pulling the most up-to-date version of the feature branch. Finally, the updated master needs to get pushed back to origin.

This process often results in a merge commit. Some developers like this because it’s like a symbolic joining of the feature with the rest of the code base. But, if you’re partial to a linear history, it’s possible to rebase the feature onto the tip of master before executing the merge, resulting in a fast-forward merge.

Some GUI’s will automate the pull request acceptance process by running all of these commands just by clicking an “Accept” button. If yours doesn’t, it should at least be able to automatically close the pull request when the feature branch gets merged into master

Dans le même temps, Jean fait exactement la même chose

While Mary and Bill are working on marys-feature and discussing it in her pull request, John is doing the exact same thing with his own feature branch. By isolating features into separate branches, everybody can work independently, yet it’s still trivial to share changes with other developers when necessary.

Marche à suivre

For a walkthrough of feature branching on Bitbucket, check out the Using Git Branches documentation. By now, you can hopefully see how feature branches are a way to quite literally multiply the functionality of the single master branch used in the Centralized Workflow. In addition, feature branches also facilitate pull requests, which makes it possible to discuss specific commits right inside of your version control GUI.

Le workflow de branche par fonctionnalité est une méthode très flexible pour développer un projet. Parfois même trop flexible. Pour les grandes équipes, il est souvent préférable d'attribuer des rôles plus spécifiques aux différentes branches. Le workflow Gitflow est un modèle commun pour gérer le développement des fonctionnalités, la préparation des livraisons et la maintenance.

Workflow Gitflow

Workflow Gitflow

The Gitflow Workflow section below is derived from Vincent Driessen at nvie.

The Gitflow Workflow defines a strict branching model designed around the project release. While somewhat more complicated than the Feature Branch Workflow, this provides a robust framework for managing larger projects.

Ce workflow n'ajoute aucun nouveau concept et aucune nouvelle commande en dehors de ce qui est exigé pour le workflow de branche par fonctionnalité. Il attribue plutôt des rôles très spécifiques aux différentes branches et définit comment et quand elles doivent interagir. Outre les branches de fonctionnalité, le workflow utilise des branches individuelles pour la préparation, la maintenance et l'enregistrement des livraisons. Bien évidemment, vous bénéficiez également de tous les avantages du workflow de branche par fonctionnalité : pull requests, expériences isolées et collaboration plus efficace.

Fonctionnement

The Gitflow Workflow still uses a central repository as the communication hub for all developers. And, as in the other workflows, developers work locally and push branches to the central repo. The only difference is the branch structure of the project.

Branches historiques

Instead of a single master branch, this workflow uses two branches to record the history of the project. The master branch stores the official release history, and the develop branch serves as an integration branch for features. It's also convenient to tag all commits in the master branch with a version number.

Branches historiques

Le reste de ce workflow est axé sur la distinction entre ces deux branches.

Branches de fonctionnalité

Each new feature should reside in its own branch, which can be pushed to the central repository for backup/collaboration. But, instead of branching off of master, feature branches use develop as their parent branch. When a feature is complete, it gets merged back into develop. Features should never interact directly with master.

Branches de fonctionnalité

Note that feature branches combined with the develop branch is, for all intents and purposes, the Feature Branch Workflow. But, the Gitflow Workflow doesn’t stop there.

Branches de livraison

Branches de livraison

Once develop has acquired enough features for a release (or a predetermined release date is approaching), you fork a release branch off of develop. Creating this branch starts the next release cycle, so no new features can be added after this point—only bug fixes, documentation generation, and other release-oriented tasks should go in this branch. Once it's ready to ship, the release gets merged into master and tagged with a version number. In addition, it should be merged back into develop, which may have progressed since the release was initiated.

En utilisant une branche dédiée pour préparer les livraisons, une équipe peut affiner la version actuelle tandis qu'une autre équipe continue de travailler sur les fonctionnalités de la livraison suivante. Cela permet également de créer des phases bien définies pour le développement (p. ex., il est facile de dire « cette semaine nous préparons la version 4.0 » et de la voir réellement dans la structure du dépôt).

Conventions communes :

  • branch off: develop
  • merge into: master
  • naming convention: release-* or release/*

Branches de maintenance

Branches de maintenance

Maintenance or “hotfix” branches are used to quickly patch production releases. This is the only branch that should fork directly off of master. As soon as the fix is complete, it should be merged into both master and develop (or the current release branch), and master should be tagged with an updated version number.

Having a dedicated line of development for bug fixes lets your team address issues without interrupting the rest of the workflow or waiting for the next release cycle. You can think of maintenance branches as ad hoc release branches that work directly with master.

Exemple

L'exemple ci-dessous montre comment ce workflow peut être utilisé pour gérer un cycle de livraison simple. Nous supposerons que vous avez déjà créé un dépôt centralisé.

Créer une branche develop

Créer une branche develop

The first step is to complement the default master with a develop branch. A simple way to do this is for one developer to create an empty develop branch locally and push it to the server:

git branch develop
git push -u origin develop

This branch will contain the complete history of the project, whereas master will contain an abridged version. Other developers should now clone the central repository and create a tracking branch for develop:

git clone ssh://user@host/path/to/repo.git
git checkout -b develop origin/develop

Tout le monde dispose désormais d'une copie locale des branches historiques configurées.

Marie et Jean commencent de nouvelles fonctionnalités

Nouvelles branches de fonctionnalité

Our example starts with John and Mary working on separate features. They both need to create separate branches for their respective features. Instead of basing it on master, they should both base their feature branches on develop:

git checkout -b some-feature develop

Ils ajoutent tous les deux des commits sur la branche de fonctionnalité de la manière habituelle : édition, staging et commits.

git status
git add <some-file>
git commit

Marie termine sa fonctionnalité

Faire un merge d'une branche de fonctionnalité

After adding a few commits, Mary decides her feature is ready. If her team is using pull requests, this would be an appropriate time to open one asking to merge her feature into develop. Otherwise, she can merge it into her local develop and push it to the central repository, like so:

git pull origin develop
git checkout develop
git merge some-feature
git push
git branch -d some-feature

The first command makes sure the develop branch is up to date before trying to merge in the feature. Note that features should never be merged directly into master. Conflicts can be resolved in the same way as in the Centralized Workflow.

Marie commence à préparer la livraison

Préparer une livraison

Tandis que Jean travaille toujours sur sa fonctionnalité, Marie commence à préparer la première livraison officielle du projet. Comme pour le développement de fonctionnalités, elle utilise une nouvelle branche pour encapsuler les préparations de livraison. Le numéro de version de la livraison est également défini à ce stade :

git checkout -b release-0.1 develop

Cette branche permet de nettoyer la livraison, de faire des tests, de mettre à jour la documentation et de préparer la prochaine livraison. C'est un peu comme une branche de fonctionnalité destinée à affiner la livraison.

As soon as Mary creates this branch and pushes it to the central repository, the release is feature-frozen. Any functionality that isn’t already in develop is postponed until the next release cycle.

Marie termine la livraison

Faire un merge de la livraison dans la branche master

Once the release is ready to ship, Mary merges it into master and develop, then deletes the release branch. It’s important to merge back into develop because critical updates may have been added to the release branch and they need to be accessible to new features. Again, if Mary’s organization stresses code review, this would be an ideal place for a pull request.

git checkout master
git merge release-0.1
git push
git checkout develop
git merge release-0.1
git push
git branch -d release-0.1

Release branches act as a buffer between feature development (develop) and public releases (master). Whenever you merge something into master, you should tag the commit for easy reference:

git tag -a 0.1 -m "Initial public release" master
git push --tags

Git comes with several hooks, which are scripts that execute whenever a particular event occurs within a repository. It’s possible to configure a hook to automatically build a public release whenever you push the master branch to the central repository or push a tag.

L'utilisateur final découvre un bug

Branche de maintenance

After shipping the release, Mary goes back to developing features for the next release with John. That is, until an end-user opens a ticket complaining about a bug in the current release. To address the bug, Mary (or John) creates a maintenance branch off of master, fixes the issue with as many commits as necessary, then merges it directly back into master.

git checkout -b issue-#001 master
# Fix the bug
git checkout master
git merge issue-#001
git push

Like release branches, maintenance branches contain important updates that need to be included in develop, so Mary needs to perform that merge as well. Then, she’s free to delete the branch:

git checkout develop
git merge issue-#001
git push
git branch -d issue-#001

Marche à suivre

By now, you’re hopefully quite comfortable with the Centralized Workflow, the Feature Branch Workflow, and the Gitflow Workflow. You should also have a solid grasp on the potential of local repositories, the push/pull pattern, and Git's robust branching and merging model.

Gardez à l'esprit que les workflows présentés ici ne sont que des exemples de ce qui est possible. Ce ne sont pas des règles immuables sur l'utilisation de Git au travail. N'hésitez pas à adopter certains aspects d'un workflow et à en ignorer d'autres. L'objectif est que Git travaille pour vous, pas l'inverse.

Workflow de duplication (fork)

The Forking Workflow is fundamentally different than the other workflows discussed in this tutorial. Instead of using a single server-side repository to act as the “central” codebase, it gives every developer a server-side repository. This means that each contributor has not one, but two Git repositories: a private local one and a public server-side one.

Workflows Git : Forking

The main advantage of the Forking Workflow is that contributions can be integrated without the need for everybody to push to a single central repository. Developers push to their own server-side repositories, and only the project maintainer can push to the official repository. This allows the maintainer to accept commits from any developer without giving them write access to the official codebase.

Résultat : un workflow distribué qui permet aux grandes équipes et aux équipes organiques (y compris les tiers non approuvés) de collaborer de façon flexible et en toute sécurité. Le workflow obtenu se prête parfaitement aux projets open source.

Fonctionnement

Comme dans les autres workflows Git, le workflow de duplication (fork) démarre par un dépôt public officiel hébergé sur un serveur. Lorsqu'un nouveau développeur veut commencer à travailler sur le projet, il ne clone pas directement le dépôt officiel.

Instead, they fork the official repository to create a copy of it on the server. This new copy serves as their personal public repository—no other developers are allowed to push to it, but they can pull changes from it (we’ll see why this is important in a moment). After they have created their server-side copy, the developer performs a git clone to get a copy of it onto their local machine. This serves as their private development environment, just like in the other workflows.

Quand il est prêt à publier un commit local, il pushe le commit vers son propre dépôt public, pas vers le dépôt officiel. Ensuite, il fait une pull request dans le dépôt principal, ce qui permet au mainteneur de projet de savoir qu'une mise à jour est prête à être intégrée. La pull request sert également de fil de discussion qui s'avère pratique en cas de problème avec le code tiers.

To integrate the feature into the official codebase, the maintainer pulls the contributor’s changes into their local repository, checks to make sure it doesn’t break the project, merges it into his local master branch, then pushes the master branch to the official repository on the server. The contribution is now part of the project, and other developers should pull from the official repository to synchronize their local repositories.

Dépôt officiel

Il est important de comprendre que la notion de dépôt « officiel » dans un workflow de duplication (fork) n'est qu'une simple convention. D'un point de vue technique, Git ne fait aucune différence entre le dépôt public de chacun des développeurs et le dépôt officiel. En réalité, la seule caractéristique qui rend le dépôt officiel si officiel est qu'il est le dépôt public du mainteneur de projet.

Création de branche dans le workflow de duplication

All of these personal public repositories are really just a convenient way to share branches with other developers. Everybody should still be using branches to isolate individual features, just like in the Feature Branch Workflow and the Gitflow Workflow. The only difference is how those branches get shared. In the Forking Workflow, they are pulled into another developer’s local repository, while in the Feature Branch and Gitflow Workflows they are pushed to the official repository.

Exemple

Le mainteneur de projet initialise le dépôt officiel

Workflow de duplication (fork) : Dépôt partagé

Comme dans tous les projets Git, la première étape consiste à créer un dépôt officiel sur un serveur accessible à tous les membres de l'équipe. Généralement, le dépôt servira également de dépôt public pour le mainteneur de projet.

Public repositories should always be bare, regardless of whether they represent the official codebase or not. So, the project maintainer should run something like the following to set up the official repository:

ssh user@host
git init --bare /path/to/repo.git

L'interface graphique de Bitbucket constitue également une alternative pratique aux commandes ci-dessus. Le process est exactement le même que celui pour la création d'un dépôt centralisé pour les autres workflows de ce tutoriel. Le mainteneur doit également faire un push de la base de code existante vers ce dépôt, si nécessaire.

Les développeurs font un fork du dépôt officiel

Workflow de duplication (fork) : Duplication du dépôt officiel.

Next, all of the other developers need to fork this official repository. It’s possible to do this by SSH’ing into the server and running git clone to copy it to another location on the server—yes, forking is basically just a server-side clone. But again, Bitbucket let developers fork a repository with the click of a button.

Une fois cette étape accomplie, tous les développeurs doivent disposer de leur propre dépôt côté serveur. Comme le dépôt officiel, tous ces dépôts doivent être bruts.

Les développeurs clonent leurs dépôts forkés

Workflow de duplication (fork) : Clonage des dépôts forkés

Next each developer needs to clone their own public repository. They can do with the familiar git clone command.

Notre exemple suppose l'utilisation de Bitbucket pour héberger ces dépôts. Gardez à l'esprit que chaque développeur doit posséder son propre compte Bitbucket et cloner le dépôt côté serveur en utilisant :

git clone https://user@bitbucket.org/user/repo.git

Whereas the other workflows in this tutorial use a single origin remote that points to the central repository, the Forking Workflow requires two remotes—one for the official repository, and one for the developer’s personal server-side repository. While you can call these remotes anything you want, a common convention is to use origin as the remote for your forked repository (this will be created automatically when you run git clone) and upstream for the official repository.

git remote add upstream https://bitbucket.org/maintainer/repo

Vous devrez créer le dépôt distant vous-même en utilisant la commande ci-dessus. Vous pourrez ainsi tenir à jour votre dépôt local à mesure que le projet officiel avancera. Notez que si l'authentification est activée pour votre dépôt distant (celui-ci n'est pas open source), vous devrez indiquer un nom d'utilisateur de la manière suivante :

git remote add upstream https://user@bitbucket.org/maintainer/repo.git

Par ce biais, les utilisateurs doivent indiquer un mot de passe valide avant de procéder au clonage ou à l'extraction de la base de code officielle.

Les développeurs travaillent sur leurs fonctionnalités

Workflow de duplication (fork) : Les développeurs travaillent sur les fonctionnalités

In the local repositories that they just cloned, developers can edit code, commit changes, and create branches just like they did in the other workflows:

git checkout -b some-feature
# Edit some code
git commit -a -m "Add first draft of some feature"

All of their changes will be entirely private until they push it to their public repository. And, if the official project has moved forward, they can access new commits with git pull:

git pull upstream master

Since developers should be working in a dedicated feature branch, this should generally result in a fast-forward merge.

Les développeurs publient leurs fonctionnalités

Workflow de duplication (fork) : Les développeurs publient leurs fonctionnalités

Once a developer is ready to share their new feature, they need to do two things. First, they have to make their contribution accessible to other developers by pushing it to their public repository. Their origin remote should already be set up, so all they should have to do is the following:

git push origin feature-branch

This diverges from the other workflows in that the origin remote points to the developer’s personal server-side repository, not the main codebase.

Second, they need to notify the project maintainer that they want to merge their feature into the official codebase. Bitbucket provides a “Pull request” button that leads to a form asking you to specify which branch you want to merge into the official repository. Typically, you’ll want to integrate your feature branch into the upstream remote’s master branch.

Le mainteneur de projet intègre leurs fonctionnalités

Workflow de duplication (fork) : Intégrer les fonctionnalités

Lorsque le mainteneur de projet reçoit la pull request, il doit décider de l'intégrer ou non dans la base de code officielle. Pour ce faire, il peut procéder de deux façons différentes :

  1. Inspecter le code directement dans la pull request

  2. Faire un pull du code dans le dépôt local et faire un merge manuel

The first option is simpler, as it lets the maintainer view a diff of the changes, comment on it, and perform the merge via a graphical user interface. However, the second option is necessary if the pull request results in a merge conflict. In this case, the maintainer needs to fetch the feature branch from the developer’s server-side repository, merge it into their local master branch, and resolve any conflicts:

git fetch https://bitbucket.org/user/repo feature-branch
# Inspect the changes
git checkout master
git merge FETCH_HEAD

Once the changes are integrated into their local master, the maintainer needs to push it to the official repository on the server so that other developers can access it:

git push origin master

Remember that the maintainer's origin points to their public repository, which also serves as the official codebase for the project. The developer's contribution is now fully integrated into the project.

Les développeurs synchronisent leurs dépôts avec le dépôt officiel

Workflow de duplication (fork) : Synchroniser avec le dépôt officiel.

La base de code ayant évolué, les autres développeurs doivent synchroniser leurs dépôts avec le dépôt officiel :

git pull upstream master

Marche à suivre

If you’re coming from an SVN background, the Forking Workflow may seem like a radical paradigm shift. But don’t be afraid—all it’s really doing is introducing another level of abstraction on top of the Feature Branch Workflow. Instead of sharing branches directly though a single central repository, contributions are published to a server-side repository dedicated to the originating developer.

This article explained how a contribution flows from one developer into the official master branch, but the same methodology can be used to integrate a contribution into any repository. For example, if one part of your team is collaborating on a particular feature, they can share changes amongst themselves in the exact same manner—without touching the main repository.

Le workflow de duplication (fork) est donc un outil très puissant pour les équipes peu soudées. N'importe quel développeur peut partager facilement ses changements avec un autre développeur, et les branches peuvent être efficacement mergées dans la base de code officielle.

Prêt à découvrir Git ?

Essayez ce tutoriel interactif.

Démarrez maintenant