Ce document contient des instructions sur la création des notes de version pour Android Studio.
Objectivité
Pour créer des notes de version détaillées pour les commits d'un dépôt GitHub.
Instructions
Suivez ces instructions dans l'ordre et dans leur intégralité.
Étape 1 : Clonez ou mettez à jour le dépôt
Recherchez un dossier "studio-main" dans ce projet. Si ce n'est pas le cas, clonez le dépôt studio-main à l'aide de la commande suivante :
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
Si le répertoire existe déjà, actualisez-le en extrayant le contenu du dépôt depuis GitHub.
Indique-moi l'état de studio-main avant de continuer.
Étape 2 : Étudiez le dépôt
Étudiez le contenu du dépôt.
Étape 3 : Récupérez les commits
Obtiens tous les commits envoyés au dépôt studio-main au cours de la période que je t'ai indiquée. Indique-moi le nombre avant de continuer. Utilisez toujours wc -l pour le décompte.
Identifiez les commits cibles : à partir du journal Git, extrayez le bloc de commit complet pour chaque commit contenant la chaîne exacte "Relnote:
", où correspond au nom du produit que j'ai fourni. Si je ne fournis pas de nom de produit, recherche simplement "Notes de version". Un "bloc de commit" inclut le hachage du commit, l'auteur, la date, le message de commit complet et la différence de code.
Utilisez le bon outil : pour filtrer les commits par plage de dates et nom de produit, utilisez la commande suivante :
git log --after="
" --before=" " --grep="Relnote: " où
et sont la plage de dates que je vous ai donnée, et est le nom du produit que je vous ai donné. Si aucun nom de produit n'est fourni, utilisez simplement la commande suivante :
git log --after="
" --before=" " --grep="Relnote" Confirme le nombre : montre-moi le nombre total, les hachages et les titres de tous les commits que tu as identifiés. Je vous donnerai une confirmation pour continuer.
Étape 4 : Générez des notes de version détaillées
Analysez chaque commit : pour chacun des commits que vous avez identifiés à l'étape précédente, effectuez une analyse détaillée, qui inclut les éléments suivants :
- Lire l'intégralité du message de commit.
- Examiner le diff de code (git show
) pour comprendre la modification. - Suivez les bugs associés (par exemple, "Bug : 12345678") pour obtenir plus de contexte.
Confirme avec moi avant de continuer.
Analysez tous les documents associés dans le dossier "docs" pour obtenir des informations sur les commits. Utilisez ces informations pour créer des notes de version riches en contenu.
Avant de continuer, indique-moi les commits qui contiennent des informations dans le dossier "docs".
Récupérez les bugs référencés dans les commits. Utilisez les informations du bug pour créer la note de version du commit.
Rédigez les notes de version : pour chaque commit, rédigez des notes de version qui incluent :
Référence du commit : faites précéder chaque note de version d'un commentaire Markdown contenant le hachage du commit source, comme ceci : .
Un titre clair : un résumé concis de la modification, en minuscules.
Explication détaillée : paragraphe expliquant la modification.
Points clés concernant le changement, dans l'ordre suivant :
a. Pourquoi : ce qui a changé et pourquoi b. Impact : impact sur les développeurs d'applications c. Migration : chemin de migration (le cas échéant)
Exemples de code "avant" et "après" : si le commit implique une modification du code visible par l'utilisateur (par exemple, des modifications DSL dans les fichiers .gradle ou des modifications d'API), fournissez des extraits de code clairs et concis illustrant la modification.
Suivez le style des notes de version sur https://developer.android.com/studio/releases.
Étape 5 : Rédigez les notes de version dans un fichier Markdown
- Créez un fichier Markdown nommé release-notes-AAAA-MM-JJTHH:MM.md à la racine du projet, où AAAA-MM-JJ (année-mois-jour) correspond à la date actuelle au format ISO 8601, T est un séparateur et HH:MM (heures:minutes au format 24 heures) correspond à l'heure actuelle.
- Rédigez une introduction qui explique l'objectif des notes de version.
- Rédige un résumé des notes de version.
- Rédige des notes de version complètes et mises en forme.
Étape 6 : Créer un commit
Créez un commit Fig pour le fichier de notes de version. N'incluez pas d'ID de bug.
Étape 7 : Créez une changelist
Créez une CL du commit.