Workflow de contrôle des sources

Pour travailler avec le code Android, vous devez utiliser Git (un système de contrôle des versions Open Source) et Repo (un outil de gestion de dépôt conçu par Google qui s'exécute sur Git). Pour comprendre la relation entre Repo et Git, et accéder à la documentation d'assistance pour chaque outil, consultez Outils de gestion du code source.

Flow

Le développement Android implique le workflow de base suivant :

1. Créez une branche de thème à l'aide de repo start.
2. Modifiez les fichiers.
3. Organisez les modifications à l'aide de git add.
4. Validez les modifications à l'aide de git commit.
5. Importez les modifications sur le serveur d'examen à l'aide de repo upload.

Tâches

Travailler avec Git et Repo dans les dépôts de code Android implique d'effectuer les tâches courantes suivantes.

Pour savoir comment utiliser Repo pour télécharger la source, consultez Télécharger la source et Référence des commandes Repo.

Synchroniser les clients

Pour synchroniser les fichiers de tous les projets disponibles :

repo sync

Pour synchroniser les fichiers des projets sélectionnés :

repo sync PROJECT0 PROJECT1 ... PROJECTN

Créer des branches de sujets

Démarrez une branche thématique dans votre environnement de travail local chaque fois que vous commencez une modification, par exemple lorsque vous commencez à travailler sur un bug ou une nouvelle fonctionnalité. Une branche thématique n'est pas une copie des fichiers d'origine. Il s'agit d'un pointeur vers un commit spécifique, ce qui facilite la création de branches locales et le passage de l'une à l'autre. Les branches vous permettent d'isoler un aspect de votre travail des autres. Pour en savoir plus sur l'utilisation des branches de thèmes, consultez Séparer les branches de thèmes.

Pour démarrer une branche de sujet à l'aide de Repo, accédez au projet et exécutez la commande suivante :

repo start BRANCH_NAME .

Le point de fin ( .) représente le projet dans le répertoire de travail actuel.

Pour vérifier que la nouvelle branche a été créée :

repo status .

Utiliser des branches thématiques

Pour attribuer la branche à un projet spécifique :

repo start BRANCH_NAME PROJECT_NAME

Pour obtenir la liste de tous les projets, consultez les dépôts Git Google. Si vous avez déjà accédé au répertoire du projet, utilisez simplement un point pour représenter le projet actuel.

Pour passer à une autre branche dans votre environnement de travail local :

git checkout BRANCH_NAME

Pour afficher la liste des branches existantes :

git branch

ou

repo branches

Les deux commandes renvoient la liste des branches existantes, avec le nom de la branche actuelle précédé d'un astérisque (*).

Organiser les fichiers

Par défaut, Git remarque les modifications que vous apportez à un projet, mais ne les suit pas. Pour indiquer à Git de conserver vos modifications, vous devez les marquer ou les préparer pour les inclure dans un commit.

Pour préparer les modifications :

git add

Cette commande accepte des arguments pour les fichiers ou les répertoires du répertoire du projet. Malgré son nom, git add n'ajoute pas seulement des fichiers au dépôt Git. Il peut également être utilisé pour préparer les modifications et les suppressions de fichiers.

Afficher l'état du client

Pour lister l'état des fichiers :

repo status

Pour afficher les modifications non validées (modifications locales qui ne sont pas marquées pour validation) :

repo diff

Pour afficher les modifications validées (modifications localisées marquées pour validation), assurez-vous d'être dans le répertoire du projet, puis exécutez git diff avec l'argument cached :

cd ~/WORKING_DIRECTORY/PROJECT
git diff --cached

Valider les modifications

Un commit est l'unité de base du contrôle des révisions dans Git. Il se compose d'un instantané de la structure de répertoire et du contenu des fichiers pour l'ensemble du projet. Exécutez cette commande pour créer un commit dans Git :

git commit

Lorsque vous êtes invité à fournir un message de commit, saisissez un message court (mais utile) pour les modifications envoyées à AOSP. Si vous n'ajoutez pas de message de commit, le commit échoue.

Importer les modifications dans Gerrit

Mettez à jour vers la dernière révision, puis importez la modification :

repo sync
repo upload

Ces commandes renvoient une liste des modifications que vous avez validées et vous invitent à sélectionner les branches à importer sur le serveur d'examen. S'il n'y a qu'une seule branche, une simple invite y/n s'affiche.

Résoudre les conflits de synchronisation

Si la commande repo sync renvoie des conflits de synchronisation :

1. Affichez les fichiers non fusionnés (code d'état = U).
2. Modifiez les régions en conflit si nécessaire.
3. Accédez au répertoire du projet concerné. Ajoutez et validez les fichiers concernés, puis rebasez les modifications :

   git add .
   git commit
   git rebase --continue
   

4. Une fois le rebasage terminé, relancez la synchronisation complète :

   repo sync PROJECT0 PROJECT1 ... PROJECTN
   

Nettoyer les clients

Après avoir fusionné les modifications dans Gerrit, mettez à jour votre répertoire de travail local, puis utilisez repo prune pour supprimer en toute sécurité les branches thématiques obsolètes :

repo sync
repo prune

Supprimer des clients

Étant donné que toutes les informations d'état sont stockées dans votre client, il vous suffit de supprimer le répertoire de votre système de fichiers :

rm -rf WORKING_DIRECTORY

La suppression d'un client supprime définitivement toutes les modifications que vous n'avez pas envoyées pour examen.