GitHub entegrasyonu

0 Giriş

GitHub Entegrasyonu, üç Easy Redmine planından herhangi birine eklenebilen bir eklentidir.

Eklentinin amacı, geliştirme faaliyetlerinin raporlanmasına, değerlendirilmesine ve sunulmasına yardımcı olmak için Easy Redmine'deki GitHub'dan önemli verileri toplamak ve böylece yazılım geliştirme projelerine ve süreçlerine yatırım yapan paydaşların karar verme sürecini desteklemektir. şirket.

Yetenekleri, GitHub örneğiniz (hem kendi kendine barındırılan hem de bulut sürümleri) ile çok basit bir ilk bağlantı içerir. Bağlantı kurulduğunda, Easy Redmine, GitHub'daki en önemli öğeleri yapılandırılabilir ve filtrelenebilir listelerde (görev listesine benzer şekilde) gösterecektir. Bu varlıklar şunlardır:

Depoları
Çekme istekleri
Kesinleştirmeler
Testler

en önemli özelliklerini içerir.

Entegrasyonun önemli bir unsuru, Easy Redmine'in depoları fiziksel olarak kopyalamamasıdır. Kod GitHub'da kalır.

1 Bağlantı kurulması

Öncelikle, GitHub'daki bir kullanıcıdan uygun izinlere sahip bir erişim belirtecine sahip olmanız gerekir.

Easy Redmine'ın GitHub'a erişeceği bir kullanıcı seçin. Bu, hiç kimsenin oturum açmadığı özel bir kullanıcı olabilir, örneğin, er_integratör
Bu kullanıcı tarafından GitHub'a giriş yapın
Avatar >> Ayarlar'a tıklayın
Geliştirici ayarları
Kişisel erişim belirteçleri
Yeni jeton oluştur
Bu kapsamlara izin vermeniz gerekiyor
- repo (Özel depoların tam kontrolü)
- admin:repo_hook (Depo kancalarının tam kontrolü)
- kullanıcı (TÜM kullanıcı verilerini güncelleyin)
jetonu kopyala

Şimdi, Easy Redmine'e gidebilir ve hayati bilgileri girebilirsiniz.
Yönetici >> Git entegrasyonuna gidin >> Bul Mevcut entegrasyonlar ve vur Ekle
Bağlantınıza bir ad verin, URL'yi ve daha önce oluşturduğunuz erişim belirtecini girin.
Not: Bulut durumunda, örn. https://github.com/robogithub-easy , sadece girin https://github.com/ alt url olmadan. Endişelenmenize gerek yok, yalnızca erişim belirtecine sahip kullanıcının görebileceği projeleri görebilirsiniz. Tüm projelerinizi özel olarak ayarlarsanız, onları başka kimse göremez.
İndirim
Bu kadar! Bağlantı yapılır.

Diğer her şey arka planda otomatik olarak yapılır. Özellikle

Easy Redmine, erişim belirtecine sahip kullanıcının üyesi olduğu tüm projeleri/depoları getirir
Bu depolarda web kancaları oluşturulur => böylece yeni taahhütler, çekme istekleri ve testler hakkındaki bilgiler Easy Redmine'a gönderilir.

1.1 Bağlantı sorunlarını giderme

Sorun A
Bu GitHub örneğinden herhangi bir depo görmüyorum
Öngörülemeyen durumlardan dolayı yukarıda belirtilen işlemlerin başarılı bir şekilde gerçekleştirilememesi söz konusu olabilir. Sonuç olarak, Easy Redmine'de bu GitHub örneğinden herhangi bir depo göremeyebilirsiniz.

Böyle bir durumda, depoları sadece birkaç tıklamayla manuel olarak içe aktarabilirsiniz.

Yönetici >> Git entegrasyonuna gidin >> Yapılandırılan entegrasyonlar >> Adı tıklayın
Yan menüde, Depo ekle
Depoyu bulun
Seçtikten sonra diğer alanlar otomatik olarak doldurulacaktır.
Tıkla İndirim
Depo eklendi

Sorun B
Depolar bulundu, ancak yeni taahhütlerim, çekme isteklerim ve testlerim Easy Redmine'e eklenmedi
GitHub'dan yeni veriler, GitHub'da yapılandırılan web kancaları aracılığıyla Easy Redmine'e gönderilir. Normal şartlar altında otomatik olarak oluşturulurlar. Bunu GitHub projenizde >> Ayarlar >> Web kancalarında doğrulayabilirsiniz.

Uygulamanızın bağlantısını içeren bir web kancası yoksa, onu oluşturmanız gerekecektir. Yine, bu basit bir işlemdir.

Yönetici >> Git entegrasyonuna gidin >> Yapılandırılan entegrasyonlar >> Adı tıklayın
Yan menüde, üzerine tıklayın Depoları
birinin adına tıklayın
Tıklayın Tüm entegrasyonları kaydet

Bu, web kancasının doğru biçimde oluşturulmasını manuel olarak zorlayacaktır.

Web kancası varsa ancak hata göstergesi içeriyorsa, lütfen hata mesajını kontrol edin ve buna göre çözmeye çalışın.

2 Referans anahtar kelime

Artık genel bağlantı yapılandırıldığına göre, Easy Redmine'de GitHub'dan zaten bilginiz var ve bunu kullanabilirsiniz. Ancak, entegrasyondan tam olarak yararlanmak için birkaç ayar daha vardır. Bazıları önceden ayarlanmıştır ve bunları yalnızca kontrol edebilirsiniz.

Belirli taahhütleri bağlamak veya belirli görevlere istekleri çekmek ve hatta Easy Redmine'i ziyaret etmek zorunda kalmadan bu şekilde zaman kaydetmek mümkündür. Bu sözde yapılır referans anahtar kelimeler. Bunları taahhüt mesajında veya istek adını görev kimliğiyle birlikte kullandığınızda, görev ile GitHub öğesi arasında bir bağlantı oluşturacaktır. En yaygın örnekler referans #1234 or #1234'ü kapatır

Çoğu durumda, önceden ayarlanmış birkaç referans anahtar kelime bulacaksınız. İşte onlarla nasıl çalışacağınız.

Genel menüye gidin >> Git entegrasyonu >> Referanslar
Referans oluştur veya düzenle
Formun tamamı, aralarında gezinmenize yardımcı olacak araç ipuçları içerir.

Hatırlanması gereken en önemli kurallar şunlardır:

Görev, #ID biçiminde tanımlanmalıdır, örneğin #1234
Kayıt süresi (izin veriliyorsa) her zaman @XhYm olarak girilir, örneğin @1h30m
Taahhütlerde, referans anahtar kelimelerin mesaj vermek
Çekme isteklerinde, referans anahtar kelimelerin isim çekme isteğinin

3 Kullanıcı eşlemesi

İki farklı uygulamanın entegrasyonu ile uğraştığımız için, her birinin farklı kullanıcı grupları var. Easy Redmine'deki GitHub ile ilgili varlıklardaki (taahhüt yazarı, çekme isteğinde gözden geçiren vb.) tüm kullanıcı öznitelikleri + referans anahtar kelimeler aracılığıyla günlüğe kaydedilen zaman, gerçek kullanıcılara bağlanmalıdır. Peki, GitHub'daki kullanıcılar aslında Easy Redmine ile nasıl eşleniyor?

Burada bilimsel bir şey yok, kullanıcılar her iki kullanıcı profilinde de e-posta yoluyla basitçe eşleştirilir. Lütfen geliştiricilerinizin hem GitHub hem de Easy Redmine'de aynı e-postalara sahip olduğundan emin olun.

Herhangi bir nedenle, bir kullanıcı e-postaları her iki uygulamada birleştiremezse, kullanıcı profilinde Easy Redmine'de ek e-posta girme seçeneği vardır -> Github e-postasını buraya girin.

4 Nasıl çalışır?

Sonunda eğlenceli kısma geliyoruz. Entegrasyonun aslında kullanıcılar için ne yaptığı. Git entegrasyonunun ana sayfasına/kontrol panosuna Eklentiler bölümünün altındaki genel menüden (sağ üstte) erişin.

Varsayılan durumda, daha sonra ihtiyaçlarınıza göre ayarlayabileceğiniz özelleştirilebilir bir sayfa bulacaksınız.

Ayrıca varlıkları listelemek veya ayarları girmek için bir menü içerir. Girişte belirtildiği gibi, Easy Redmine, GitHub'dan 4 önemli varlığı toplar ve görüntüler. Her birine daha yakından bakalım.

4.1 Depolar

Depolar listesi, gerçekten gerekli olmasına rağmen, işlevsel olarak en az ilginç olanıdır. Bahsetmeye değer yararlı bir filtre denir Hizmetbağlı çeşitli GitHub örnekleriniz varsa ve yalnızca bazılarını aramanız gerekiyorsa kullanacağınız .

Depo detayı

Notlar:

(Un-)Tüm entegrasyonları kaydet Bölüm 1.1'de açıklanmıştır. GitHub projesinde web kancaları oluşturacak/silecek.
Düzenle - bazı özellikleri manuel olarak değiştirin. Easy Redmine'deki havuzun herhangi bir özelliğini düzenlemek için gelişmiş hata ayıklama dışında hiçbir neden yoktur.
senkronize etmek - depodaki tüm güncel verileri indirir.
Çekme istekleri - bu depodaki tüm çekme isteklerini listeler.
Sıra şablonu seçin - hala geliştirme aşamasında, lütfen bu sağlam aracı cilalamamız için bize daha fazla zaman verin.

4.2 Çekme istekleri (Kod istekleri)

Neden iki isim olduğunu açıklığa kavuşturmalıyız. Çekme isteği GitHub'da kullanılan terimdir. Diğer araçların bunun için farklı adları vardır, örneğin Birleştirme isteği. Aracımızın entegrasyon mekanizması, desteği diğer Git platformlarına genişletebilmemiz için genel bir şekilde yazılmıştır. Bu nedenle, uygulamada ve resimlerde etiket bulabilirsiniz. Kod isteği, Bu, Çekme isteklerine veya Birleştirme isteklerine uygulanabilecek genel bir terimdir.

Çekme talebi, doğrudan Easy Redmine'de güzel listeler, raporlar ve hatta bunların üzerinde grafikler oluşturmaya izin veren zengin bir varlıktır (tüm önemli özellikleri saklar).

Çekme isteğinin ayrıntısı

Notlar:

Çekme isteğinin adı, "refs" referans anahtar sözcüğünü ve ardından # 765 karmalı görev kimliğini içerir - bu nedenle görev 765'e bağlanmıştır
Tıklayarak senkronize etmek bu PR'nin tüm verilerini GitHub'dan güncelleyecek
Tüm nitelikler, çekme istekleri listesinde gösterilebilir
SHA dışındaki tüm nitelikler, çekme istekleri listesinde/raporunda/grafiklerinde filtre olarak kullanılabilir
Çekme istek listesi ayrıca, en önemlisi - Test durumu ile ilgili testlerin (CI/CD) özelliklerini de içerir.

4.3 Taahhütler

Çekme isteklerine benzer şekilde, taahhüt listesi de geniş raporlama olanakları sağlar. Taahhüt listesi ayrıca testlerden öznitelikler içerir.

Commit'in Easy Redmine'de kendi detay görünümü yoktur. Sadece buna gerek yok. URL'ye (veya SHA'ya) tıklayarak GitHub'daki ayrıntılarına yönlendirileceksiniz.

4.4 Testleri

Yukarıdaki varlıklarla ilgili olarak bahsedilmiştir. Testlerin ayrıca çeşitli raporlar oluşturmak için kendi listeleri vardır. Muhtemelen en yaygın kullanım, sürüm adayları gibi kritik depolardaki testlerin canlı görüntüsü olacaktır.

Test ayrıca kendi detay görünümüne sahip değildir, tıklamak sizi GitHub'a götürecektir.

4.5 Sinerji - görevden görünüm

Gelin hep birlikte nasıl olduğuna bir göz atalım.

1 Bu görevle ilgili GitHub varlıklarının genel durumu. Çeşitli renk kombinasyonları (kırmızı, turuncu, yeşil) ve simgeler (onay işareti, çarpı işareti) içerebilir. En iyisi, elbette, yeşil çerçevedeki yeşil onay işaretidir.
Kombinasyon, çekme isteğinin/isteklerinin durumuna ve taahhütler ve çekme istekleriyle ilgili test sonuçlarına bağlıdır. Amacı, özellikle QA veya teslimat yöneticileri için yararlı olan bu görevin "teknik" ilerlemesinin nasıl gittiğini ilk bakışta göstermektir.

2 Bu göreve ilişkin değişikliklerin gerçekleştirildiği depo(lar)ın adı. Bağlantıya tıklayarak bu taahhütlerin listesine yönlendirileceksiniz.

3 Bu göreve atıfta bulunan çekme isteğinin/isteklerinin adı. Üzerine tıklayarak Easy Redmine'deki PR'ın detaylarına yönlendirileceksiniz.
Yalnızca bu göreve atıfta bulunan taahhütler varsa ancak çekme isteği eksikse bu değer boştur.

4 Her çekme isteğinin durumu. Üzerine tıklayarak GitHub'daki çekme isteği detayına yönlendirileceksiniz.
Yalnızca bu göreve atıfta bulunan taahhütler varsa ancak çekme isteği eksikse bu değer boştur.

5 Çekme talebindeki son test çalıştırmasının sonucu. Üzerine tıklayarak GitHub'a yönlendirileceksiniz. içinde tıklanabilir değil Bilinmiyor durum (test mevcut değil).
Yalnızca bu göreve atıfta bulunan taahhütler varsa, ancak çekme talebi eksikse, değer, son taahhütte çalıştırılan son test sonucunu gösterir.

6 Testi manuel olarak çalıştırın - sizi GitHub'a götürür.

7 Bir çekme isteği oluşturmak için tıklayın. Yalnızca bir dizi taahhüdünüz olduğunda, ancak PR'yi kaçırdığınızda kullanışlıdır (sizi GitHub'a götürür).

4.6 Görevden dal oluştur

Bazı kullanıcılar, doğrudan görevden bir dal oluşturmayı kullanışlı bulur.

Düğme şurada bulunabilir: genel menü görev detayında

Otomatik tamamlama alanında depoyu seçin. Şube adı, görev kimliği ve konusu ile önceden doldurulmuştur, ancak bunu değiştirebilirsiniz. Kaynak şube tarafından önceden doldurulmuş usta

Görevde Git entegrasyonu bölümünün altında dalı etiket olarak göreceksiniz. Tıklanabilir ve GitHub'daki şubeye yönlendirir.

5 İzinler

Şu anda iki izin var.

Görünüm - Eklentiye genel menüden erişin
Yönet - kontrol panelini düzenleyin

Genel yapılandırmaya yalnızca Easy Redmine yöneticisi tarafından erişilebilir.