İçeriğe atla
SinaptikLabAI KNOWLEDGE PLATFORM

LAB · AÇIK KAYNAK

İstem Sürümleme Kiti

İstemleri kod gibi sürümleyen, her değişikliği gerekçesiyle kayda geçiren ve yayındaki sürümü tek adımda geri alınabilir tutan kit. Kimin neyi neden değiştirdiğinin sorulabilir olması için kurulur.

Durum

Geliştiriliyor

Bu projenin girdi tanımları, arayüz tasarımıyla birlikte yayımlanacak.

Geliştiriliyor

İstem Sürümleme Kiti henüz yayında değil

Bu proje geliştirme listesinde. Yayına girdiğinde bültenle duyurulacak; çalışan araçları Lab sayfasından görebilirsiniz.

02YÖNTEM

Projenin içi

Kurulum, varsayımlar, ölçüm düzeni ve sınırlılıklar.

Ne çözüyor?#

İstem metni ya kodun içine gömülü ya da bir yönetim ekranındaki tek kutuda tutulduğunda, dünkü metnin ne olduğu ve neden değiştiği hiçbir yerde kayıtlı olmuyor. Kit istemi ayrı bir varlık olarak ele alıyor: metin, üst künye, değişiklik gerekçesi ve bağlı değerlendirme koşusu aynı kaydın alanları. Yayına alma da metni düzenlemek değil, var olan bir sürümü işaret etmek anlamına geliyor.

Bileşenler#

  • İstem dosyası — metni ve üst künyeyi birlikte taşır; künyesi eksik kayıt kabul edilmez.
  • Sürüm kaydı — her değişikliği yeni bir sürüm olarak yazar, öncekini silmez veya üzerine yazmaz.
  • İşaretçi — hangi ortamda hangi sürümün yayında olduğunu tek yerde tutar.
  • Gerekçe alanı — neyin hangi gözlem üzerine değiştirildiğini serbest metin olarak zorunlu kılar.
  • Değerlendirme bağı — sürümü, onu koşturan değerlendirme kaydının kimliğine bağlar.
  • Şablon denetleyicisi — metindeki değişken yerlerinin çağıran koddaki sözleşmeyle uyumunu kontrol eder.

Sürüm kaydı ne taşır#

Kayıt, metnin yanında o metni okumak için gereken bağlamı da taşıyor: hangi modelle kullanıldığı, hangi değişkenleri beklediği ve hangi değerlendirme koşusuna bağlandığı. Künye zorunlu olduğu için küçük düzeltme diye geçilen değişiklikler de iz bırakıyor. Metnin kendisi künyeden sonra, biçimlendirilmeden olduğu gibi saklanıyor.

yaml
surum: <artan sayı>
kimlik: <istem adı>
hedefModel: <model kimliği>
degiskenler: [<ad>, <ad>]
degisiklikGerekcesi: <metin>
degerlendirmeKosusu: <koşu kimliği>
onaylayan: <kişi>
durum: <taslak | yayinda | geri-alindi>
---
<istem metni>

Kurulum akışı#

  1. 1İstemleri koddan çıkar

    Her istemi kendi dosyasına taşı; çağıran kodda yalnızca istem kimliği ile sürüm işaretçisi kalsın.

  2. 2Künyeyi zorunlu kıl

    Eksik künyeli veya gerekçesiz kaydı birleştirme aşamasında reddeden bir denetim ekle; kural kodda değil denetimde dursun.

  3. 3İşaretçiyi ortamlara ayır

    Deneme ve yayın ortamları ayrı işaretçi tutsun; yayına alma yalnızca işaretçinin değerini değiştirsin.

  4. 4Geri almayı tatbikat haline getir

    Önceki sürüme dönüşü gerçek bir değişiklik üzerinde dene; işlemeyen bir geri alma yolu, kayıt düzeninin tek başına yetmediğini gösterir.

Yapılandırmaya bırakılan kararlar#

KararSeçeneklerBelirleyen
Depolama yeriSürüm kontrolü, veritabanı, ikisi birlikteİstemi kimin düzenlediği: geliştirici mi editör mü
Sürüm numaralamaArtan sayı, anlamsal sürüm, içerik özetiGeriye dönük uyumun izlenmesi gerekip gerekmediği
Yayına alma yetkisiTek kişi, çift onay, değerlendirme geçtiğinde kendiliğindenHatalı istemin etkisinin genişliği
Değişken sözleşmesiSerbest yer tutucu, şema doğrulaması, tipli arayüzİstemi çağıran yüzeylerin sayısı
Eski sürümlerin saklanmasıSüresiz, belirli sayıda, dondurulmuş arşivDenetim ve geriye dönük inceleme gereği
Yayına alma yetkisi ile değerlendirme bağı birlikte kararlaştırılır; koşuya bağlanmayan bir sürüm kendiliğinden yayına alınamaz.

Geri alma#

Geri alma, kitin en sık kullanılan yolu olacak biçimde tasarlanıyor: işaretçiyi önceki sürüme çevirmek, metni elle düzeltmekten her zaman daha kısa bir yol. Bunun çalışması için önceki sürümün beklediği değişken sözleşmesinin de değişmemiş olması gerekiyor. Sözleşme değiştiyse işaretçiyi çevirmek tek başına yetmiyor; çağıran kodun da o sürümle uyumlu haline dönmesi gerekiyor. Kit bu bağı kayıtta tutuyor, kararı ekibe bırakıyor.

Kapsam dışı#

Kit istemin içeriğini iyileştirmiyor; yalnızca hangi içeriğin ne zaman yayında olduğunu izlenebilir tutuyor. İstem yazım rehberi, kendiliğinden iyileştirme, çok dilli çeviri yönetimi ve trafiği bölerek karşılaştırma kitin dışında kalıyor. Değerlendirme koşusunun kendisi de ayrı bir bileşenin işi: kit yalnızca sürüm ile koşu arasındaki bağı saklıyor.

04DİĞER PROJELER

Lab'dan

BUILD

Hesap tuttu, sıra uygulamada

Aynı hesabı kendi verinizle yapıp mimariyi kurmak için kurumsal destek alabilirsiniz.