Bu belgede, Android Studio için sürüm notları oluşturma talimatları yer almaktadır.
Amaç
GitHub deposundaki commit'ler için ayrıntılı sürüm notları oluşturmak üzere kullanılır.
Talimatlar
Bu talimatları sırayla ve eksiksiz bir şekilde uygulayın.
1. adım: Depoyu klonlayın veya güncelleyin
Bu projede studio-main klasörünün olup olmadığını kontrol edin. Yoksa aşağıdaki komutu kullanarak studio-main deposunu klonlayın:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
Dizin zaten varsa GitHub'dan depo içeriğini çekerek dizini yenileyin.
Devam etmeden önce lütfen studio-main'in durumunu bildirin.
2. adım: Depoyu inceleyin
Deponun içeriğini inceleyin.
3. adım: Commit'leri alın
Size sağladığım zaman aralığında stüdyo-ana deposuna gönderilen tüm commit'leri al. Devam etmeden önce sayıyı bana bildir. Sayma işlemi için her zaman wc -l komutunu kullanın.
Hedef işlemeleri belirleyin: Git günlüğünden, sağladığım ürün adı olan
ile başlayan "Relnote: " dizesini içeren her işleme için tam işleme bloğunu çıkarın. Ürün adı belirtmezsem "Relnote" araması yapın. "Commit block" (işleme bloğu); işleme karma değerini, yazarı, tarihi, tam işleme mesajını ve kod farkını içerir.
Doğru aracı kullanın: Commit'leri tarih aralığına ve ürün adına göre filtrelemek için aşağıdaki komutu kullanın:
git log --after="
" --before=" " --grep="Relnote: " Burada
ve , size verdiğim tarih aralığı, ise size verdiğim ürün adıdır. Ürün adı sağlanmamışsa yalnızca aşağıdaki komutu kullanın:
git log --after="
" --before=" " --grep="Relnote" Sayımı onayla: Belirlediğin tüm commit'lerin toplam sayısını, karma değerlerini ve başlıklarını göster. Devam etmeniz için size onay vereceğim.
4. adım: Ayrıntılı sürüm notları oluşturun
Her bir commit'i analiz edin: Önceki adımda belirlediğiniz her bir commit için aşağıdakileri içeren ayrıntılı bir analiz yapın:
- Commit mesajının tamamını okuma
- Değişikliği anlamak için kod farkını (git show
) inceleyin. - Daha fazla bağlam bilgisi edinmek için bağlantılı hataları (ör. Hata: 12345678) takip edin.
Devam etmeden önce benimle iletişime geçin.
Commit'lerle ilgili bilgiler için dokümanlar klasöründeki ilgili dokümanları analiz edin. İçerik açısından zengin bir sürüm notu oluşturmak için bu bilgileri kullanın.
Devam etmeden önce, dokümanlar klasöründe hangi commit'lerin ilgili bilgiler içerdiğini bana bildirin.
Commit'lerde referans verilen hataları alın. Commit için sürüm notu oluşturmaya yardımcı olması amacıyla hatadaki bilgileri kullanın.
Sürüm notunu yazın: Her bir commit için aşağıdakileri içeren bir sürüm notu yazın:
Commit referansı: Her sürüm notunun başına, kaynak commit karmasını içeren bir Markdown yorumu ekleyin. Örneğin: .
Net bir başlık: Değişikliğin kısa ve cümle büyük harfiyle yazılmış özeti.
Ayrıntılı açıklama: Değişikliğin neyle ilgili olduğunu açıklayan bir paragraf.
Aşağıdaki sırayla değişiklikle ilgili önemli noktalar:
a. Neden: Ne değişti ve neden değişti? b. Etki: Uygulama geliştiriciler üzerindeki etki c. Taşıma: Taşıma yolu (varsa)
"Önce" ve "sonra" kod örnekleri: İşleme, kullanıcıya yönelik bir kod değişikliği (ör. .gradle dosyalarındaki DSL değişiklikleri veya API değişiklikleri) içeriyorsa değişikliği gösteren net ve kısa kod snippet'leri sağlayın.
https://developer.android.com/studio/releases adresindeki sürüm notu stilini kullanın.
5. adım: Sürüm notlarını bir Markdown dosyasına yazın
- Projenin kök dizininde release-notes-YYYY-MM-DDTHH:MM.md adlı bir Markdown dosyası oluşturun. ISO 8601 biçiminde YYYY-AA-GG (yıl-ay-gün) geçerli tarih, T ayırıcı ve HH:MM (24 saatlik saat diliminde saat:dakika) geçerli saattir.
- Sürüm notlarının amacını açıklayan bir giriş yazın.
- Sürüm notlarının özetini yaz.
- Biçimlendirilmiş sürüm notlarının tamamını yaz.
6. adım: Commit oluşturun
Sürüm notları dosyası için bir Fig commit'i oluşturun. Hata kimliği eklemeyin.
7. adım: Değişiklik listesi oluşturun
Commit'in CL'sini oluşturun.