Bazel modülleri

Sorun bildirme Kaynağı görüntüleme Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel modülü, birden fazla sürümü olabilecek bir Bazel projesidir. Her sürüm, bağlı olduğu diğer modüller hakkında meta veriler yayınlar. Bu, diğer bağımlılık yönetimi sistemlerindeki (Maven yapı, npm paketi, Go modülü veya kargo kabı) bilinen kavramlara benzer.

Bir modülün, depo kökünde (WORKSPACE dosyasının yanında) bir MODULE.bazel dosyası olmalıdır. Bu dosya, modülün adını, sürümünü, doğrudan bağımlılıklarının listesini ve diğer bilgileri açıklayan manifest dosyasıdır. Temel bir örnek:

module(name = "my-module", version = "1.0")

bazel_dep(name = "rules_cc", version = "0.0.1")
bazel_dep(name = "protobuf", version = "3.19.0")

Modül çözümlemesini gerçekleştirmek için Bazel işe kök modülün MODULE.bazel dosyasını okuyarak başlar ve ardından bütün bağımlılık grafiğini bulana kadar bir Bazel kayıt defterinden bağımlılığın MODULE.bazel dosyasını sürekli olarak ister.

Ardından Bazel, varsayılan olarak her modülün kullanılacak bir sürümünü seçer. Bazel, her modülü bir depoyla temsil eder ve depoların her birinin nasıl tanımlanacağını öğrenmek için kayıt defterine tekrar başvurur.

Sürüm biçimi

Bazel'in çeşitli bir ekosistemi vardır ve projelerde çeşitli sürümlendirme şemaları kullanılır. En popüler olan SemVer olsa da Abseil gibi farklı şemalar kullanan önemli projeler de vardır. Bu projelerde sürümler tarihe dayanır (ör. 20210324.2).

Bu nedenle Bzlmod, SemVer spesifikasyonunun daha esnek bir sürümünü kullanır. Farklılıklar şunlardır:

  • SemVer, sürümün "sürüm" kısmının 3 segmentten oluşması gerektiğini belirtir: MAJOR.MINOR.PATCH. Bazel'de bu koşul gevşetilmiştir. Böylece, istenen sayıda segmente izin verilir.
  • SemVer'de "sürüm" bölümündeki her segment yalnızca rakam içermelidir. Bazel'de bu, harflere de izin verecek şekilde gevşetilir ve karşılaştırma semantikleri, "ön sürüm" bölümündeki "tanımlayıcılar" ile eşleşir.
  • Ayrıca, ana, alt ve yama sürümü artışlarının semantikleri zorunlu kılınmaz. Bununla birlikte, geriye dönük uyumluluğu nasıl ifade ettiğimizle ilgili ayrıntılar için uyumluluk düzeyine bakın.

Geçerli tüm SemVer sürümleri geçerli Bazel modülü sürümüdür. Ayrıca, iki SemVer sürümü a ve b, Bazel modülü sürümleri olarak karşılaştırıldığında aynı sonucu verirse ve yalnızca bu durumda a < b ile karşılaştırılır.

Sürüm seçimi

Sürümlü bağımlılık yönetimi alanında temel bir unsur olan elmas bağımlılık sorununu düşünün. Aşağıdaki bağımlılığı grafiğiniz olduğunu varsayalım:

       A 1.0
      /     \
   B 1.0    C 1.1
     |        |
   D 1.0    D 1.1

D'nin hangi sürümü kullanılmalıdır? Bzlmod, bu soruyu yanıtlamak için Go modül sisteminde sunulan Minimal Sürüm Seçimi (MVS) algoritmasını kullanıyor. MVS, bir modülün tüm yeni sürümlerinin geriye dönük uyumlu olduğunu varsayar ve bu nedenle, herhangi bir bağımlı tarafından belirtilen en yüksek sürümü (örneğimizde D 1.1) seçer. D 1.1, gereksinimlerimizi karşılayabilecek en eski sürüm olduğu için "minimum" olarak adlandırılır. D 1.2 veya daha yeni sürümler olsa bile bunları seçmeyiz. MVS kullanmak, yüksek kaliteli ve yeniden üretilebilir bir sürüm seçim süreci oluşturur.

Geri çekilen sürümler

Kayıt defteri, belirli sürümlerin kullanılmasından kaçınılması gerekiyorsa (ör. güvenlik açıkları nedeniyle) bu sürümleri geri çekilmiş olarak tanımlayabilir. Bazel, bir modülün geri çekilmiş sürümünü seçerken hata veriyor. Bu hatayı düzeltmek için daha yeni ve yankı olmayan bir sürüme geçin veya yanked sürüme açıkça izin vermek için --allow_yanked_versions işaretini kullanın.

Uyumluluk düzeyi

Go'da MVS'nin geriye dönük uyumluluk varsayımı, bir modülün geriye dönük uyumsuz sürümlerini ayrı bir modül olarak ele aldığı için işe yarar. SemVer açısından bu, A 1.x ve A 2.x'ün farklı modüller olarak kabul edildiği ve çözülmüş bağımlılık grafiğinde birlikte bulunabileceği anlamına gelir. Bu da Go'da paket yolunda ana sürümün kodlanmasıyla mümkün olur. Böylece, herhangi bir derleme zamanı veya bağlantı zamanı çakışması olmaz.

Ancak Bazel bu tür garantiler sağlayamaz. Bu nedenle, geriye dönük uyumlu olmayan sürümleri algılamak için "büyük sürüm" numarasına ihtiyacı vardır. Bu sayı uyumluluk seviyesi olarak adlandırılır ve module() yönergesindeki her modül sürümü tarafından belirtilir. Bazel, bu bilgilerle, çözülmüş bağımlılık grafiğinde aynı modülün farklı uyumluluk düzeylerine sahip sürümlerinin bulunduğunu tespit ettiğinde hata verebilir.

Geçersiz kılar:

Bazel modül çözümlemesinin davranışını değiştirmek için MODULE.bazel dosyasında geçersiz kılma işlemlerini belirtin. Yalnızca kök modülün geçersiz kılma işlemleri geçerli olur. Bir modül bağımlılık olarak kullanılırsa geçersiz kılma işlemleri dikkate alınmaz.

Her geçersiz kılma, belirli bir modül adı için belirtilir ve bağımlılık grafiğindeki tüm sürümlerini etkiler. Yalnızca kök modülün geçersiz kılma işlemleri geçerli olsa da bu geçersiz kılma işlemleri, kök modülün doğrudan bağlı olmadığı geçişli bağımlılar için olabilir.

Tek sürüm geçersiz kılma

single_version_override birden fazla amaca hizmet eder:

  • version özelliğiyle, bağımlılığın hangi sürümlerinin bağımlılığı grafiğinde istendiğine bakılmaksızın bir bağımlılığı belirli bir sürüme sabitleyebilirsiniz.
  • registry özelliğiyle, normal kayıt defteri seçimi işlemini izlemek yerine bu bağımlılığı belirli bir kayıt defterinden gelmeye zorlayabilirsiniz.
  • patch* özellikleriyle, indirilen modüle uygulanacak bir yama grubu belirtebilirsiniz.

Bu özelliklerin tümü isteğe bağlıdır ve birbirleriyle karıştırılabilir ve eşleştirilebilir.

Birden fazla sürümün geçersiz kılınması

Çözüme ulaştırılan bağımlılık grafiğinde aynı modülün birden fazla sürümünün birlikte var olmasına izin vermek için bir multiple_version_override belirtilebilir.

Modül için izin verilen sürümlerin açık bir listesini belirtebilirsiniz. Bu sürümlerin tümü, çözümden önce bağımlılık grafiğinde bulunmalıdır. İzin verilen her sürüme bağlı olarak bir geçişli bağımlılık bulunmalıdır. Çözümleme işleminden sonra, modülün yalnızca izin verilen sürümleri kalır. Bazel ise modülün diğer sürümlerini aynı uyumluluk düzeyinde izin verilen en yakın sürüme yükseltir. Aynı uyumluluk düzeyinde izin verilen daha yüksek bir sürüm yoksa Bazel hata verir.

Örneğin, çözümleme öncesi bağımlılık grafiğinde 1.1, 1.3, 1.5, 1.7 ve 2.0 sürümleri varsa ve büyük sürüm uyumluluk düzeyiyse:

  • 1.3, 1.7 ve 2.0'ye izin veren birden fazla sürümün geçersiz kılınması, 1.1'in 1.3, 1.5'in 1.7 sürümüne yükseltilmesine ve diğer sürümlerin aynı kalmasına neden olur.
  • 1.5 ve 2.0'e izin veren birden fazla sürüm geçersiz kılma işlemi, 1.7'nin aynı uyumluluk düzeyinde yükseltilebilecek daha yüksek bir sürümü olmadığı için hatayla sonuçlanır.
  • Çözümden önce bağımlılık grafiğinde 1.9 bulunmadığı için 1.9 ve 2.0'e izin veren birden fazla sürüm geçersiz kılma işlemi hata verir.

Ayrıca kullanıcılar, tek sürüm geçersiz kılmalara benzer şekilde registry özelliğini kullanarak kayıt defterini geçersiz kılabilir.

Kayıt otoritesi dışındaki geçersiz kılmalar

Kayıt dışı geçersiz kılma işlemleri, bir modülü sürüm çözünürlüğünden tamamen kaldırır. Bazel, bu MODULE.bazel dosyalarını bir kayıt defterinden değil, deponun kendisinden ister.

Bazel, kayıt otoritesi dışındaki aşağıdaki geçersiz kılma işlemlerini destekler:

Depo adları ve katı bağımlılar

Bir modülü destekleyen deponun kanonik adı module_name~version'dir (ör. bazel_skylib~1.0.3). Kayıt defteri dışındaki bir geçersiz kılma içeren modüller için version bölümünü override dizesiyle değiştirin. Standart ad biçiminin, güvenebileceğiniz bir API olmadığını ve her an değişebileceğini unutmayın.

Bir modülü doğrudan bağımlılarına destekleyen bir deponun görünür adı, bazel_dep yönergesinin repo_name özelliği aksini belirtmediği sürece varsayılan olarak modül adıdır. Bu, bir modülün yalnızca doğrudan bağımlılarını bulabileceği anlamına gelir. Bu, geçişli bağımlılıklardaki değişiklikler nedeniyle yanlışlıkla oluşabilecek kesintileri önlemeye yardımcı olur.

Modül uzantıları, bir modülün görünür kapsamına ek depolar da ekleyebilir.