Etiket: Yazılım Geliştirme

GitHub Actions: [skip ci] Kullanarak İş Akışlarını Atlamak ve Optimize Etmek

Günümüzde yazılım geliştirme süreçleri gitgide daha fazla otomasyona bağlıdır. Sürekli Entegrasyon ve Sürekli Dağıtım (CI/CD) sistemleri, yazılım kalitesini artırmak, testleri otomatikleştirmek ve hızlı geri bildirim sağlamak için önemlidir. Bu alanda GitHub Actions popüler bir platform olarak karşımıza çıkar. Ancak bazı durumlarda, CI/CD sürecinin tetiklenmemesi gerekebilir. İşte bu tür durumlar için [skip ci] komutları devreye girer.

Bu yazıda, GitHub Actions üzerinde iş akışlarını (workflow) belirli durumlarda nasıl atlayacağınızı ve bunu yaparken nelere dikkat etmeniz gerektiğini detaylarıyla açıklıyoruz.

[skip ci] Ne Anlama Gelir?

[skip ci], GitHub Actions tarafından tetiklenecek push ve pull_request iş akışlarını atlamak için commit mesajlarına eklenen bir anahtar kelimedir. Bu ifade sayesinde CI/CD süreçleri tetiklenmez, böylece kaynak ve zaman tasarrufu sağlanır.

GitHub Actions tarafından desteklenen atlama komutları şunlardır:

  • [skip ci]
  • [ci skip]
  • [no ci]
  • [skip actions]
  • [actions skip]

Bu ifadelerden herhangi biri, commit mesajının herhangi bir yerinde bulunabilir.

[skip ci] Hangi Durumlarda Kullanılır?

İş akışlarını atlamak için en yaygın kullanım senaryoları şöyledir:

  • Dokümantasyon güncellemeleri
  • Yazım hataları (typo) gibi küçük değişiklikler
  • CI testlerinin gereksiz olduğu küçük stil düzenlemeleri
  • CI süreçlerinin tekrarlamasının gerekli olmadığı durumlar

GitHub Actions’ta İş Akışları Nasıl Atlanır?

1. Commit Mesajına Ekleyerek İş Akışlarını Atlamak

Commit mesajınızda aşağıdaki gibi [skip ci] ekleyebilirsiniz:

git commit -m "Dokümantasyon güncellendi [skip ci]"

Alternatif kullanım:

git commit -m "[ci skip] Küçük typo düzeltildi"

2. Push İşlemlerinde İş Akışlarını Atlamak

Bir push işleminde bulunan herhangi bir commit mesajında [skip ci] bulunuyorsa, push işlemi sırasında tetiklenmesi gereken GitHub Actions iş akışları otomatik olarak atlanır.

3. Pull Request (Çekme İsteği) İşlemlerinde İş Akışlarını Atlamak

Çekme isteği (PR) durumlarında, sadece PR’ın HEAD commit’inde [skip ci] gibi bir ifade varsa, iş akışı tetiklenmez. Ancak PR’larda dikkat edilmesi gereken önemli bir nokta var:

  • Eğer GitHub üzerinde bazı kontrollerin başarıyla tamamlanması zorunlu hâle getirildiyse, [skip ci] kullanımı PR’ın birleştirilmesini engelleyebilir çünkü iş akışı çalıştırmaları beklemede kalır.
  • Bu durumda, kontrolleri geçmek için PR’a ek commit gönderilmelidir.

skip-checks Komutu Kullanımı (Alternatif Yöntem)

Commit mesajınızın sonuna özel fragmanlar ekleyerek (skip-checks:true) de CI süreçlerini atlayabilirsiniz.

Örneğin:

Doküman güncellemesi yapıldı

skip-checks: true

Bu komut, GitHub tarafından fragman (trailer) olarak kabul edilir ve iki boş satırla ayrılarak eklenir. Bu yöntem, daha ayrıntılı kontrol isteyen geliştiriciler tarafından tercih edilir.

Önemli Not:

  • Git, varsayılan olarak ardışık boş satırları otomatik olarak kaldırır. Bu nedenle commit mesajınızın tam olarak korunmasını sağlamak için aşağıdaki komutu kullanmalısınız:
git commit --cleanup=verbatim -m "Doküman güncellemesi yapıldı

skip-checks: true"

[skip ci] Kullanımında Dikkat Edilmesi Gereken Noktalar

  • Atlanmış iş akışı, beklemede (Pending) olarak kalabilir ve zorunlu kontrollerde sorun oluşturabilir.
  • Kritik testler veya entegrasyon aşamaları için bu yöntemi kullanmayın. Risk oluşturabilecek durumlarda mutlaka CI akışlarının çalıştırılması gerekir.
  • Atlanan iş akışları sadece push ve pull_request etkinliklerini etkiler. Örneğin pull_request_target gibi etkinlikleri etkilemez.
  • Bir workflow’u tamamen devre dışı bırakmak istiyorsanız, GitHub’ın workflow yönetiminden (disable workflow) bunu ayrıca yapmanız gerekir.

İş Akışı YAML Dosyasında Koşul Kullanımı (İleri Seviye Kullanım)

Aşağıdaki YAML örneğiyle [skip ci] kontrolünü daha hassas biçimde yönetebilirsiniz:

name: CI Pipeline

on: [push, pull_request]

jobs:
  test:
    if: "!contains(github.event.head_commit.message, '[skip ci]')"
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Testleri Çalıştır
      run: |
        ./run-tests.sh

Bu YAML, commit mesajında [skip ci] bulunduğunda, belirtilen işi (test) çalıştırmaz.

Diğer Platformlarla Karşılaştırma (GitLab CI)

Benzer şekilde GitLab CI üzerinde de [skip ci] kullanılabilir. GitLab CI için ek yöntem olarak git push sırasında opsiyon olarak ci.skip kullanılır:

git push origin <branch> --push-option=ci.skip

GitHub Actions ise henüz bu tarz push-option’ları desteklemez. Ancak gelecekte benzer özellikler eklenebilir.

Sonuç ve En İyi Uygulamalar

GitHub Actions’ta [skip ci] özelliğini kullanmak, gereksiz iş akışı tetiklemelerini önleyerek kaynakları ve zamanı verimli kullanmanızı sağlar. Bu özellik, günlük küçük düzenlemeler ve dokümantasyon güncellemeleri için son derece faydalıdır. Ancak kritik süreçlerde dikkatle kullanılması gerekir.

Bu yöntemle, CI/CD süreçlerinizi daha temiz, hızlı ve yönetilebilir hâle getirebilirsiniz.

API Nedir? Uygulama Programlama Arabirimlerinin Keşfi

API’lerin Tanımı

API Nedir? API’ler, iki yazılım bileşeninin belirli tanımlar ve protokoller aracılığıyla birbiriyle iletişim kurmasına olanak tanıyan mekanizmalardır. Örneğin, meteoroloji müdürlüğünün yazılım sistemi, günlük hava durumu verilerini içerir. Telefonunuzdaki hava durumu uygulaması, API’ler aracılığıyla bu sistemle “konuşur” ve telefonunuzda size günlük hava durumu güncellemelerini gösterir.

API’nin açılımı nedir?

API’nin açılımı olan Application Programming Interface, Uygulama Programlama Arabirimi anlamına gelir. API’ler bağlamında Uygulama sözcüğü, ayrı bir işlevi bulunan her türlü yazılımı ifade eder. Arabirim, iki uygulama arasındaki hizmet sözleşmesi gibi düşünülebilir. Bu sözleşme, ikisinin istekler ve yanıtlar kullanarak birbiriyle nasıl iletişim kuracağını tanımlar. İlişkili API belgeleri, geliştiricilerin bu istek ve yanıtları nasıl yapılandırması gerektiğine dair bilgiler içerir.

API’ler nasıl çalışır?

API mimarisi genellikle istemci ve sunucu bakımından açıklanır. İsteği gönderen uygulamaya istemci, yanıtı gönderen uygulamaya ise sunucu adı verilir. Yani hava durumu örneğinde, müdürlüğün hava durumu veri tabanı bir sunucu iken, mobil uygulama ise bir istemcidir. 

Ne zaman ve nasıl oluşturulduklarına dayalı olarak API’ler dört farklı şekilde çalışabilir.

SOAP API’leri 

Bu API’ler, Basit Nesne Erişimi Protokolünü kullanır. İstemci ve sunucu, XML aracılığıyla mesaj alışverişi yapar. Bu, diğerlerine kıyasla pek esnek olmayan ve artık popülerliğini yitiren bir API’dir.

RPC API’leri

Bu API’lere, Uzak Prosedür Çağrıları adı verilir. İstemci, önce sunucu üzerinde bir işlevi (yani prosedür) tamamlar ve ardından sunucu da çıktıyı istemciye gönderir.

WebSocket API’leri

WebSocket API’leri, verileri aktarmak için JSON nesneleri kullanan başka bir modern web API’si gelişimidir. Bir WebSocket API’si, istemci uygulamaları ile sunucu arasında iki yönlü iletişimi destekler. Sunucunun bağlı istemcilere geri arama mesajları gönderebilmesi nedeniyle REST API’lerinden daha verimlidir.

REST API’leri

Bunlar günümüzde web’de bulunan en popüler ve esnek API’lerdir. İstemci, sunucuya isteklerini veri olarak gönderir. Sunucu bu istemci girdisini kullanarak dahili işlevleri başlatır ve çıktı verilerini tekrar istemciye gönderir. Aşağıda REST API’lerini daha ayrıntılı inceleyelim.

REST API’si nedir?

REST, Temsili Durum Aktarımı anlamına gelen Representational State Transfer ifadesinin kısaltmasıdır. REST, istemcilerin sunucu verilerine erişirken kullanabilmesi için GET, PUT, DELETE gibi belirli işlevler kullanır. İstemciler ve sunucular, HTTP üzerinden veri alışverişi yapar.

REST API’sinin ana özelliği durumsuz olmasıdır. Durumsuz olması, sunucuların istekler arasında istemci verilerini kaydetmemesi anlamına gelir. İstemcinin sunucuya gönderdiği istekler, bir web sitesini ziyaret etmek için tarayıcınıza yazdığınız URL’lere benzer. Gelen yanıt ise bir web sayfasında görmeye alışık olduğumuz grafikleri içermeyen sade verilerdir.

Web API’si nedir?

Bir Web API’si veya Web Hizmeti API’si, bir web sunucusu ile web tarayıcısı arasındaki uygulama işleme arabirimidir. Tüm web hizmetleri birer API’dir ancak tüm API’ler web hizmeti değildir. REST API’leri, yukarıda açıklanan standart mimari stilini kullanan özel bir Web API’si türüdür.

API’lerle ilgili olarak Java API’si veya hizmet API’leri gibi farklı terimlerinin olmasının sebebi, API’lerin World Wide Web’den önce oluşturulmuş olmalarıdır. Modern web API’leri birer REST API’sidir ve terimler birbirinin yerine kullanılabilir.

API entegrasyonu nedir?

API Entegrasyonu nedir? API entegrasyonları, istemciler ile sunucular arasındaki verileri otomatik olarak güncelleyen yazılım bileşenleridir.

Telefonunuzun görüntü galerisindeki verilerin buluta otomatik olarak senkronize edilmesi veya başka bir saat dilimine seyahat ettiğinizde dizüstü bilgisayarınızın tarih ve saatinin otomatik olarak senkronize edilmesi, API entegrasyonlarına örnek olarak verilebilir. Kurumlar da birçok sistem işlevini etkili bir şekilde otomatikleştirmek için bunları kullanabilir.

New API GW Diagram.c9fc9835d2a9aa00ef90d0ddc4c6402a2536de0d 1.67a41a2ef9823282fe672434ddd56dd22c13d5a5

REST API’lerinin avantajları nelerdir?

REST API’lerinin sunduğu dört temel avantaj vardır:

1. Entegrasyon 

API’ler, yeni uygulamaların mevcut yazılım sistemlerine entegre edilmesi için kullanılır. Her bir işlevi sıfırdan yazmaya gerek duyulmadığından geliştirme hızı artar. Mevcut kodlardan yararlanmaya devam etmek için API’leri kullanabilirsiniz.

2. İnovasyon 

Yeni bir uygulamanın gelişi, bütün bir sektörü değişime zorlayabilir. İşletmelerin hızlı yanıt vermesi ve yenilikçi hizmetlerin hızlı dağıtımını desteklemesi gerekir. Bunu, tüm kodu yeniden yazmak yerine API düzeyinde değişiklikler yaparak gerçekleştirebilirler.

3. Genişleme

API’ler, müşterilerinin ihtiyaçlarını birden fazla platformda karşılamak isteyen işletmelere benzersiz bir fırsat sunar. Örneğin, haritalar API’si harita bilgileri entegrasyonunun web siteleri, Android, iOS vb. aracılığıyla yapılabilmesini sağlar. Her işletme, ücretsiz veya ücretli API’leri kullanarak kendi dahili veritabanlarına benzer şekilde erişim verebilir.

4. Bakım kolaylığı

API, iki sistem arasında bir ağ geçidi vazifesi görür. Her bir sistem, API’nin etkilenmemesi için dahili değişiklikler yapma gereği duyar. Bu sayede, taraflardan birinin gelecekte yapacağı kod değişiklikleri, diğer tarafı etkilemez.

Farklı API türleri nelerdir?

API Nedir ve türleri nelerdir? API’ler, hem mimarilerine hem de kullanım kapsamlarına göre sınıflandırılır. Ana API mimarisi türlerini zaten incelediğimize göre, şimdi de kullanım kapsamına göz atalım.

Özel API’ler

Bunlar, her bir kurumda dahili kullanım içindir ve sadece işletmenin içindeki sistem ve verileri bağlamak için kullanılır.

Genel API’ler 

Bunlar, halka açık olup herkes tarafından kullanılabilir. Bu API türlerinin bazıları için yetkilendirme adımları ve maliyetler söz konusuyken, bazıları tamamen açık ve ücretsizdir.

Çözüm Ortağı API’leri 

Bunlar, sadece işletmeler arası ortaklıklarda yardım sağlamaları için yetkilendirilmiş harici geliştiricilerin erişimine açıktır.

Birleşik API’ler 

Bunlar, karmaşık sistem gereksinimlerini veya davranışlarını ele almak üzere iki veya daha fazla API’yi bir araya getirir. 

API uç noktası nedir ve neden önemlidir?

API Uç Noktası Nedir? API uç noktaları, API iletişim sistemindeki nihai temas noktalarıdır. Bunlara sunucu URL’leri, hizmetler ve bilgilerin sistemler arasında gönderilip alındığı diğer belirli dijital konumlar dahildir. API uç noktalarının kurumlar için kritik öneme sahip olmasının iki ana sebebi vardır: 

1. Güvenlik

API uç noktaları, sistemi saldırılara karşı hassas hale getirir. API’lerin izlenmesi, kötüye kullanımı önleme açısından büyük önem taşır.

2. Performans

Yüksek trafikli olanlar başta olmak üzere API uç noktaları, darboğazlara yol açabilir ve sistem performansını etkileyebilir.

Bir REST API’si nasıl güvenceye alınır?

Tüm API’ler, uygun kimlik doğrulama ve izleme faaliyetleriyle güvenceye alınmalıdır. REST API’lerini güvenceye almanın en temel iki yöntemi şunlardır:

1. Kimlik doğrulama belirteçleri 

Bunlar, API çağrısında bulunacak olan kullanıcıların yetkilendirilmesi için kullanılır. Kimlik doğrulama belirteçleri, her bir kullanıcının iddia ettiği kişi olup olmadığını ve ilgili API çağrısı için gerekli erişim haklarına sahip olup olmadığını kontrol eder. Örneğin, e-posta sunucunuzda oturum açtığınızda, e-posta istemciniz güvenli erişim için kimlik doğrulaması yapar.

2. API anahtarları 

API anahtarları, API çağrısında bulunan programı veya uygulamayı doğrular. Bunlar, uygulamayı tanır ve uygulamanın ilgili API çağrısında bulunmak için gerekli erişim haklarına sahip olduğundan emin olur. Belirteçler kadar güvenli olmamakla birlikte API anahtarları, kullanım hakkında veri toplamak amacıyla API izlemeyi mümkün kılar. Çeşitli web sitelerini ziyaret ettiğinizde tarayıcınızın URL çubuğunda karakterlerden ve sayılardan oluşan uzun bir dize olduğunu fark etmişsinizdir. Bu dize, web sitesinin dahili API çağrıları yapmak için kullandığı bir API anahtarıdır.

Nasıl API oluşturulur?

Diğer geliştiricilerin kullanmak isteyeceği ve güveneceği bir API oluşturmak, büyük özen ve emek isteyen bir iştir. Yüksek kaliteli API tasarımı için gerekli beş adım şunlardır:

1. API’yi planlama 

OpenAPI gibi API teknik özellikleri, API tasarımınızın şemasını sağlar. Farklı kullanım senaryolarını önceden düşünmek ve API’nin güncel API geliştirme standartlarına uyduğundan emin olmak en iyisidir.

2. API’yi oluşturma

 API tasarımcıları, ortak kod kullanarak bir API prototipi hazırlar. Prototip test edildikten sonra, geliştiriciler dahili teknik özelliklere göre özelleştirme yapabilir.

3. API’yi test etme  

Tıpkı yazılım testlerinde olduğu gibi, hata ve kusurları önlemek için API testleri yapılmalıdır. API üzerinde siber saldırılara karşı kuvvet testi yapmak için API test etme araçları kullanılabilir.

4. API belgeleri yazma  

API’lerin nasıl kullanılacağı kendiliğinden anlaşılsa da API belgeleri, kullanışlılığı artıracak bir kılavuz işlevi görür. Geniş bir yelpazede işlevler ve kullanım senaryoları sunmanın yanında belgeleri de kaliteli olan API’ler, hizmet odaklı bir mimaride genellikle daha popüler olmaktadır.

5. API’yi pazarlama 

Tıpkı Amazon’un perakende ticaret için bir çevrimiçi pazar yeri olması gibi, geliştiricilerin diğer API’leri alıp satabilmesi için API pazar yerleri de mevcuttur. API’nizi kaydettirmeniz, gelir elde etmenize imkan tanıyabilir.

API testi nedir?

API test etme stratejileri, diğer yazılım test etme metodolojilerine benzer. Ana odak noktası, sunucu yanıtlarını doğrulamaktır. API testleri şunları içerir:

  • Performans testi için API uç noktalarına birden fazla istek göndermek.
  • İş mantığını ve işlevlerin doğruluğunu kontrol etmek için birim testleri yazmak.
  • Sistem saldırılarını simüle ederek güvenlik testleri yapmak. 

API belgeleri nasıl yazılır?

Kapsamlı API belgeleri yazmak, API yönetimi sürecinin bir parçasıdır. API belgeleri, araçlar kullanılarak otomatik oluşturulabilir ya da manuel olarak yazılabilir. En iyi uygulamalardan bazıları şunlardır:

  • Açıklamaları kolayca okunabilen, basit bir dille yazmak. Araçlar tarafından oluşturulan belgeler zor anlaşılabilir ve düzenleme gerektirebilir.
  • İşlevleri açıklamak için kod örnekleri kullanmak.
  • Belgeleri doğru ve güncel tutmak.
  • Yazma tarzını belirlerken yeni başlayanları hedeflemek.
  • API’nin kullanıcılar için çözebileceği tüm sorunlara yer vermek.

Sonuç

API’ler, modern yazılım geliştirme dünyasının ayrılmaz bir parçasıdır. İşletmelerin, geliştiricilerin ve tüketicilerin günlük yaşamlarını daha kolay ve daha verimli hâle getirmek için kullanabileceği güçlü araçlar sunarlar.