Questo documento contiene istruzioni per creare le note di rilascio per Android Studio.
Obiettivo
Per creare note di rilascio dettagliate per i commit di un repository GitHub.
Istruzioni
Segui queste istruzioni in sequenza e in modo completo.
Passaggio 1: clona o aggiorna il repository
Controlla la presenza di una cartella studio-main in questo progetto. Se non esiste, clona il repository studio-main utilizzando il seguente comando:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
Se la directory esiste già, aggiornala estraendo i contenuti del repository da GitHub.
Fammi sapere lo stato di studio-main prima di procedere.
Passaggio 2: studia il repository
Studia i contenuti del repository.
Passaggio 3: recupera i commit
Recupera tutti i commit inviati al repository studio-main durante il periodo di tempo che ti ho fornito. Fammi sapere il conteggio prima di procedere. Utilizza sempre wc -l per il conteggio.
Identifica i commit di destinazione: dal log Git, estrai il blocco di commit completo per ogni commit che contiene la stringa esatta "Relnote:
", dove è il nome del prodotto che ho fornito. Se non fornisco un nome di prodotto, cerca "Relnote". Un "blocco di commit" include l'hash del commit, l'autore, la data, il messaggio di commit completo e la differenza di codice.
Utilizza lo strumento corretto: per filtrare i commit in base all'intervallo di date e al nome del prodotto, utilizza il seguente comando:
git log --after="
" --before=" " --grep="Relnote: " dove
e sono l'intervallo di date che ti ho fornito e è il nome del prodotto che ti ho fornito. Se non viene fornito un nome del prodotto, utilizza il seguente comando:
git log --after="
" --before=" " --grep="Relnote" Conferma il conteggio: mostrami il conteggio totale, gli hash e i titoli di tutti i commit che hai identificato. Ti darò una conferma per procedere.
Passaggio 4: genera note di rilascio dettagliate
Analizza ogni commit: per ogni commit identificato nel passaggio precedente, esegui un'analisi dettagliata, che include:
- Leggere l'intero messaggio di commit.
- Esaminando la differenza di codice (git show
) per comprendere la modifica. - Seguendo eventuali bug collegati (ad esempio, Bug: 12345678) per raccogliere maggiori informazioni.
Conferma con me prima di procedere.
Analizza tutti i documenti correlati nella cartella dei documenti per informazioni relative ai commit. Utilizza queste informazioni per creare una nota di rilascio ricca di contenuti.
Prima di procedere, fammi sapere quali commit contengono informazioni correlate nella cartella docs.
Recupera tutti i bug a cui viene fatto riferimento nei commit. Utilizza le informazioni nel bug per creare le note di rilascio per il commit.
Scrivi la nota di rilascio: per ogni commit, scrivi una nota di rilascio che includa:
Riferimento al commit: anteponi a ogni nota di rilascio un commento Markdown contenente l'hash del commit di origine, ad esempio: .
Un titolo chiaro: un riepilogo conciso e in formato frase della modifica.
Una spiegazione dettagliata: un paragrafo che spiega in cosa consiste la modifica.
Punti chiave della modifica nel seguente ordine:
a. Perché: cosa è cambiato e perché b. Impatto: l'impatto sugli sviluppatori di app c. Migrazione: il percorso di migrazione (se presente)
Esempi di codice "prima" e "dopo": se il commit comporta una modifica del codice visibile all'utente (ad esempio, modifiche DSL nei file .gradle o modifiche API), fornisci snippet di codice chiari e concisi che dimostrino la modifica.
Segui lo stile delle note di rilascio all'indirizzo https://developer.android.com/studio/releases.
Passaggio 5: scrivi le note di rilascio in un file Markdown
- Crea un file Markdown denominato release-notes-AAAA-MM-GGTHH:MM.md nella directory principale del progetto, dove AAAA-MM-GG (anno-mese-giorno) è la data corrente nel formato ISO 8601, T è un separatore, e HH:MM (ore:minuti nel formato 24 ore) è l'ora corrente.
- Scrivi un'introduzione che spieghi lo scopo delle note di rilascio.
- Scrivi un riepilogo delle note di rilascio.
- Scrivi le note di rilascio complete e formattate.
Passaggio 6: crea un commit
Crea un commit Fig per il file delle note di rilascio. Non includere un ID bug.
Passaggio 7: crea un elenco delle modifiche
Crea un CL del commit.