Ten dokument zawiera instrukcje tworzenia informacji o wersji Android Studio.
Cel
Aby utworzyć szczegółowe informacje o wersji dotyczące commitów z repozytorium GitHub.
Instrukcje
Postępuj zgodnie z tymi instrukcjami w podanej kolejności.
Krok 1. Sklonuj lub zaktualizuj repozytorium
Sprawdź, czy w tym projekcie znajduje się folder studio-main. Jeśli nie istnieje, sklonuj repozytorium studio-main za pomocą tego polecenia:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
Jeśli katalog już istnieje, odśwież go, pobierając zawartość repozytorium z GitHub.
Przed kontynuowaniem podaj stan repozytorium studio-main.
Krok 2. Zapoznaj się z repozytorium
Zapoznaj się z zawartością repozytorium.
Krok 3. Pobierz commity
Pobierz wszystkie zmiany przesłane do repozytorium studio-main w podanym przeze mnie okresie. Zanim przejdziesz dalej, podaj mi liczbę. Do zliczania zawsze używaj polecenia wc -l.
Określ docelowe commity: z dziennika git wyodrębnij pełny blok commita dla każdego commita, który zawiera dokładny ciąg znaków „Relnote:
”, gdzie to podana przeze mnie nazwa produktu. Jeśli nie podam nazwy produktu, wyszukaj „Relnote”. „Blok zatwierdzenia” zawiera hash zatwierdzenia, autora, datę, pełną wiadomość zatwierdzenia i różnicę w kodzie.
Użyj odpowiedniego narzędzia: aby filtrować zatwierdzenia według zakresu dat i nazwy produktu, użyj tego polecenia:
git log --after="
" --before=" " --grep="Relnote: " gdzie
i to podany przeze mnie zakres dat, a to podana przeze mnie nazwa produktu. Jeśli nazwa produktu nie jest podana, użyj tego polecenia:
git log --after="
" --before=" " --grep="Relnote" Potwierdź liczbę: pokaż mi łączną liczbę, hasze i tytuły wszystkich zidentyfikowanych przez Ciebie commitów. Potwierdzę, że możesz przejść dalej.
Krok 4. Wygeneruj szczegółowe informacje o wersji
Analiza każdego zatwierdzenia: w przypadku każdego zatwierdzenia zidentyfikowanego w poprzednim kroku przeprowadź szczegółową analizę, która obejmuje:
- Odczytywanie pełnej wiadomości o zatwierdzeniu.
- Sprawdź różnice w kodzie (git show
), aby zrozumieć zmianę. - śledzenie powiązanych błędów (np. Błąd: 12345678), aby uzyskać więcej informacji.
Zanim przejdziesz dalej, potwierdź ze mną.
Analizuj wszystkie powiązane dokumenty w folderze docs, aby uzyskać informacje o zatwierdzeniach. Wykorzystaj te informacje, aby utworzyć bogate w treści informacje o wersji.
Przed przejściem dalej poinformuj mnie, które commity mają powiązane informacje w folderze docs.
Pobierz wszystkie błędy, do których odwołują się commity. Skorzystaj z informacji o błędzie, aby utworzyć notatkę o wersji dla zatwierdzenia.
Napisz informacje o wersji: w przypadku każdego zatwierdzenia napisz informacje o wersji, które obejmują:
Odwołanie do zatwierdzenia: przed każdą informacją o wersji umieść komentarz w języku Markdown zawierający hash źródłowego zatwierdzenia, np. tak: .
Jasny tytuł: zwięzłe podsumowanie zmiany w formie zdania.
Szczegółowe wyjaśnienie: akapit wyjaśniający, na czym polega zmiana.
Najważniejsze informacje o zmianie w tej kolejności:
a. Dlaczego: co się zmieniło i dlaczego b. Wpływ: wpływ na deweloperów aplikacji c. Migracja: ścieżka migracji (jeśli istnieje)
Przykłady kodu „przed” i „po”: jeśli zatwierdzenie obejmuje zmianę kodu widoczną dla użytkownika (np. zmiany DSL w plikach .gradle lub modyfikacje interfejsu API), podaj jasne i zwięzłe fragmenty kodu ilustrujące tę zmianę.
Postępuj zgodnie ze stylem informacji o wersjach na stronie https://developer.android.com/studio/releases.
Krok 5. Zapisz informacje o wersji w pliku Markdown
- Utwórz w katalogu głównym projektu plik Markdown o nazwie release-notes-RRRR-MM-DDTHH:MM.md, gdzie RRRR-MM-DD (rok-miesiąc-dzień) to bieżąca data w formacie ISO 8601, T to separator, a HH:MM (godziny:minuty w formacie 24-godzinnym) to bieżąca godzina.
- Napisz wprowadzenie, które wyjaśnia cel informacji o wersji.
- Napisz podsumowanie informacji o wersji.
- Napisz pełne, sformatowane informacje o wersji.
Krok 6. Utwórz zatwierdzenie
Utwórz zatwierdzenie Fig dla pliku z informacjami o wersji. Nie podawaj identyfikatora błędu.
Krok 7. Utwórz listę zmian
Utwórz listę zmian z zatwierdzeniem.