contract-proof
Amaç
Değişen API, olay ve veri sözleşmelerinin (OpenAPI/Swagger, AsyncAPI, JSON Schema, GraphQL SDL, protobuf; depoda hangisi varsa) geriye ve ileriye dönük uyumluluğunu kanıtlar.
Kaynak Skill amacı
Ne zaman kullanılır
Bir değişiklik API, olay veya veri sözleşmesinin uyumluluğunu etkileyebileceğinde contract-proof kullanılır. Projedeki sözleşme biçimlerini, önce mevcut uyumluluk aracıyla, gerekirse yerleşik yapısal karşılaştırmayla inceler. Her değişiklik kural kimliği, yön ve kırıcı, kırıcı olmayan veya inceleme isteyen sınıf alır. Etki raporu depodaki tüketicileri gösterir; depo dışı tüketiciler bilinmez kalır. Kırıcı davranış dondurulmuş planda sürümleme, geçiş veya kaldırma yolu ister. Hiçbir aracın okuyamadığı biçim desteklenmiyor sayılır, sessizce kabul edilmez.
Değişiklik kayıtlı karşılaştırma komutuyla ölçülür veya somut kaynak satırları boyunca izlenir. Öğe adı şemayı, işlemi ya da kanalı ve tam ilgili özelliği gösterir. Belirsiz sınıflandırma iki sözleşme sürümü okunarak yeniden değerlendirilir. Planda ele alınmış kırıcı değişiklik de yerel tüketicileriyle raporda görünür; hiçbir aracın anlayamadığı dosya ise desteklenmiyor olarak kalır.
Kaynak Skill amacı
Nasıl çalışır
Kaynak Skill akışı
- Hedefi belirle Temel sürümü, son sürümü ve uyumluluk kararlarında kullanılacak planı kaydet.
Kaynak Skill akışı
- Sözleşmeleri karşılaştır Değişen her sözleşme dosyasında yerleşik karşılaştırmayı çalıştır.
Kaynak Skill akışı
- Tüketicileri bul Kırıcı veya belirsiz değişikliklerin depo içi tüketicilerini etki raporundan bul.
Kaynak Skill akışı
- Mevcut araçları kullan Algılama bulursa biçime özel kurulu uyumluluk aracını çalıştır.
Kaynak Skill akışı
- Belirsizliği çöz Belirsiz değişikliklerin kural sınıflandırmasını onaylamadan veya değiştirmeden önce her iki sürümü oku.
Kaynak Skill akışı
- Yargıları kaydet Yazılı plan veya belirtim ölçütünü ihlal etmeyen gözlemleri ayrı tut.
Kaynak Skill akışı
- Doğrula ve bildir Karşılaştırma verisini doğrula; planlı kırıcı değişiklikleri ve desteklenmeyen biçimleri bildir.
Kaynak Skill akışı
Temel kurallar
- Değişikliği kayıtlı komutla ölç veya somut kaynak satırlarıyla izle.
Kaynak Kanıt kuralları
- Her değişikliğe uyumluluk sınıfını belirleyen bir kural kimliği ver.
Kaynak Kanıt kuralları
- Okunamayan değişmiş biçimi geçiyor saymak yerine desteklenmiyor diye işaretle.
Kaynak Kanıt kuralları
- Her değişiklikte tam şema, işlem veya kanal ile özelliği adlandır.
Kaynak Kanıt kuralları
- Yerel arama tüketici bulmasa da depo dışındakileri bilinmez say.
Kaynak Kanıt kuralları
Çıktı ve gate
Çıktı
- İnceleme için doğrulanmış sözleşme verisi, rapor ve günlük üret.
Kaynak Çıktı tanımı
gate
- Plansız kırıcı veya belirsiz değişiklik uyumluluk incelemesini engeller.
Kaynak Gate kuralı: REVIEW contract focus
- Okunamayan sözleşme dosyaları veya tanınan sözleşme olmaması desteklenmiyor sonucu verir.
Kaynak Gate kuralı: REVIEW contract focus
- Engelleyici veya desteklenmeyen durum yoksa uyumluluk incelemesi geçer.
Kaynak Gate kuralı: REVIEW contract focus
Kaynak
Kaynak Skill tanımı