Dieses Dokument enthält eine Anleitung zum Erstellen der Versionshinweise für Android Studio.
Ziel
Detaillierte Versionshinweise für Commits aus einem GitHub-Repository erstellen.
Anleitung
Folgen Sie dieser Anleitung Schritt für Schritt und vollständig.
Schritt 1: Repository klonen oder aktualisieren
Suchen Sie in diesem Projekt nach einem Ordner „studio-main“. Wenn kein solches Repository vorhanden ist, klonen Sie das Repository „studio-main“ mit dem folgenden Befehl:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
Wenn das Verzeichnis bereits vorhanden ist, aktualisieren Sie es, indem Sie den Inhalt des Repositorys von GitHub abrufen.
Bitte teile mir den Status von „studio-main“ mit, bevor du fortfährst.
Schritt 2: Repository untersuchen
Sehen Sie sich den Inhalt des Repositorys an.
Schritt 3: Commits abrufen
Rufe alle Commits ab, die im angegebenen Zeitraum an das Repository „studio-main“ gesendet wurden. Teile mir die Anzahl mit, bevor du fortfährst. Verwenden Sie zum Zählen immer „wc -l“.
Ziel-Commits identifizieren: Extrahieren Sie aus dem Git-Log den vollständigen Commit-Block für jeden Commit, der den genauen String „Relnote:
“ enthält, wobei der von mir angegebene Produktname ist. Wenn ich keinen Produktnamen angebe, suche einfach nach „Relnote“. Ein „Commit-Block“ enthält den Commit-Hash, den Autor, das Datum, die vollständige Commit-Nachricht und den Code-Diff.
Das richtige Tool verwenden: Mit dem folgenden Befehl können Sie Commits nach Zeitraum und Produktname filtern:
git log --after="
" --before=" " --grep="Relnote: " Dabei sind
und der von mir angegebene Zeitraum und der von mir angegebene Produktname. Wenn kein Produktname angegeben ist, verwenden Sie einfach den folgenden Befehl:
git log --after="
" --before=" " --grep="Relnote" Bestätige die Anzahl: Zeige mir die Gesamtzahl, die Hashes und die Titel aller Commits, die du gefunden hast. Ich gebe dir dann eine Bestätigung, dass du fortfahren kannst.
Schritt 4: Detaillierte Versionshinweise generieren
Jeden Commit analysieren: Führen Sie für jeden der im vorherigen Schritt ermittelten Commits eine detaillierte Analyse durch, die Folgendes umfasst:
- Die vollständige Commit-Nachricht lesen
- Untersuchen Sie den Code-Diff (git show
), um die Änderung zu verstehen. - Folgen Sie allen verlinkten Fehlern (z. B. Fehler: 12345678), um mehr Kontext zu erhalten.
Bestätige das bitte, bevor du fortfährst.
Analysieren Sie alle zugehörigen Dokumente im Ordner „docs“, um Informationen zu den Commits zu erhalten. Nutzen Sie diese Informationen, um ausführliche Versionshinweise zu erstellen.
Teile mir mit, welche Commits zugehörige Informationen im Ordner „docs“ enthalten, bevor du fortfährst.
Ruft alle Fehler ab, auf die in den Commits verwiesen wird. Nutzen Sie die Informationen im Fehler, um die Versionshinweise für den Commit zu erstellen.
Versionshinweise schreiben: Schreiben Sie für jeden Commit Versionshinweise, die Folgendes enthalten:
Commit-Referenz: Stellen Sie jeder Versionsanmerkung einen Markdown-Kommentar mit dem Quell-Commit-Hash voran, z. B.: .
Ein klarer Titel: Eine prägnante Zusammenfassung der Änderung in normaler Schreibweise.
Eine detaillierte Erklärung: Ein Absatz, in dem die Änderung erläutert wird.
Wichtige Punkte zur Änderung in der folgenden Reihenfolge:
a. Warum: Was hat sich geändert und warum? b. Auswirkungen: Auswirkungen auf App-Entwickler c. Migration: Der Migrationspfad (falls vorhanden)
„Vorher“- und „Nachher“-Codebeispiele: Wenn der Commit eine für Nutzer sichtbare Codeänderung enthält (z. B. DSL-Änderungen in .gradle-Dateien oder API-Änderungen), stellen Sie klare, prägnante Code-Snippets bereit, die die Änderung veranschaulichen.
Halten Sie sich an den Stil der Versionshinweise unter https://developer.android.com/studio/releases.
Schritt 5: Release-Hinweise in eine Markdown-Datei schreiben
- Erstellen Sie im Stammverzeichnis des Projekts eine Markdown-Datei mit dem Namen „release-notes-YYYY-MM-DDTHH:MM.md“. Dabei ist YYYY-MM-DD (Jahr-Monat-Tag) das aktuelle Datum im ISO 8601-Format, T ist ein Trennzeichen und HH:MM (Stunden:Minuten im 24-Stunden-Format) ist die aktuelle Uhrzeit.
- Schreiben Sie eine Einleitung, in der der Zweck der Versionshinweise erläutert wird.
- Schreibe eine Zusammenfassung der Versionshinweise.
- Schreibe die vollständigen, formatierten Versionshinweise.
Schritt 6: Commit erstellen
Erstellen Sie einen Fig-Commit für die Datei mit den Versionshinweisen. Geben Sie keine Programmfehler-ID an.
Schritt 7: Änderungsliste erstellen
Erstellen Sie eine CL für das Commit.