Lint ve birim testi çalıştırma
GitHub Actions, olaylar tarafından tetiklenen görevleri otomatikleştirmek için kullanılabilir. Çekme isteği oluşturulduğunda kod kalitesi denetimlerini tetiklemeniz için şunları yapmanız gerekir:
- Linter'ler ve birim testleri ile kodunuzu doğrulayın.
- Çekme istekleriyle kod denetimlerini tümleştirme.
Kodunuzu doğrulayın
Kodunuz üzerinde yapmak isteyeceğiniz iki yaygın denetim türü vardır: lintler ve birim testleri.
Kodunuzun kuruluşunuzun belirlediği kalite yönergelerine uyup uymadığını denetlemek için lintleri kullanabilirsiniz. Örneğin, kodunuzu Flake8 ile lint etmek için kodunuzun uyması gereken kuralları içeren bir .flake8 yapılandırma dosyası oluşturacaksınız.
Kodun beklendiği gibi çalışıp çalışmadığını denetlemek için birim testleri oluşturabilirsiniz. Kodunuzun belirli bölümlerini kolayca test etmek için betikleriniz işlevler içermelidir. Test dosyaları oluşturarak betiklerinizdeki işlevleri test edebilirsiniz. Python kodunu test etmek için popüler bir araç Pytest'tir.
Bahşiş
Pytest ile birim testleri çalıştırma hakkında daha fazla bilgi edinin.
GitHub Actions'ı kullanarak kodunuzu denetlemek için aşağıdakileri yapmanız gerekir:
- Aracı yükleyin (Flake8 veya Pytest).
- Deponuzda denetlenilmesi gereken klasörleri belirterek testleri çalıştırın.
Bahşiş
GitHub Actions ile kodu otomatik olarak veya Visual Studio Code'da el ile doğrulayabilirsiniz. Kodunuzu yerel olarak doğrulama hakkında daha fazla bilgi edinin.
Çekme istekleriyle kod denetimlerini tümleştirme.
Çekme isteği oluşturulduğunda GitHub Actions iş akışını tetikleme için kullanabilirsiniz on: pull_request.
Çekme isteğinin yalnızca tüm kalite denetimleri geçtiğinde birleştirilebileceğinden emin olmak istiyorsunuz.
Kod denetimlerini ana dalı hedefleyen çekme istekleriyle tümleştirmek için şunları yapmanız gerekir:
- Deponuzdaki Ayarlar sekmesine gidin.
- Dallar'ı seçin.
- Ana dal için dal koruma kuralı içinde birleştirmeden önce durum denetimlerinin geçirilmesini gerektir seçeneğini etkinleştirin.
Burada linterlerinizi ve birim testlerinizi arayıp seçerek gerektiği gibi ayarlayabilirsiniz. Daha sonra bir çekme isteği oluşturduğunuzda, bunun GitHub Actions'ınızı tetiklediğini ve yalnızca iş akışları başarıyla geçtiğinde çekme isteğini birleştirebileceksiniz.
Dekont
Çekme isteğini birleştirmeden önce kod denetimlerini gerekli olacak şekilde yapılandırmak için, işinizin GitHub Actions iş akışında bir adı olmalıdır. Daha sonra iş adlarını arayarak denetimleri bulabilirsiniz.