Bazel Kilit Dosyası

Bazel'deki kilit dosyası özelliği, bir projenin gerektirdiği yazılım kitaplıklarının veya paketlerin belirli sürümlerinin ya da bağımlılıklarının kaydedilmesini sağlar. Bunu, modül çözünürlüğü ve uzantı değerlendirmesinin sonucunu depolayarak yapar. Kilit dosyası, tutarlı geliştirme ortamları sağlayarak yeniden üretilebilir derlemeleri destekler. Ayrıca, proje bağımlılıklarında değişiklik olmadığında Bazel'in çözüm sürecini atlamasına olanak tanıyarak derleme verimliliğini artırır. Ayrıca kilit dosyası, harici kitaplıklarda beklenmedik güncellemeleri veya bozucu değişiklikleri önleyerek kararlılığı artırır ve böylece hata ekleme riskini azaltır.

Kilit dosyası oluşturma

Kilit dosyası, çalışma alanı kökü altında MODULE.bazel.lock adıyla oluşturulur. Derleme işlemi sırasında, özellikle de modül çözümlemesi ve uzantı değerlendirmesinden sonra oluşturulur veya güncellenir. Kilit dosyası, MODULE dosyası, işaretler, geçersiz kılma işlemleri ve diğer ilgili bilgiler de dahil olmak üzere projenin mevcut durumunu yakalar. Daha da önemlisi, yalnızca derlemenin mevcut çağrısına dahil edilen bağımlılıkları içerir.

Projede bağımlılıklarını etkileyen değişiklikler olduğunda, kilit dosyası yeni durumu yansıtacak şekilde otomatik olarak güncellenir. Bu sayede kilit dosyası, mevcut derleme için gereken belirli bağımlılık grubuna odaklanmaya devam eder ve projenin çözülmüş bağımlılıklarının doğru bir temsilini sağlar.

Kilit Dosyası Kullanımı

Proje durumu kilit dosyasından farklı olduğunda Bazel'in davranışını özelleştirmek için kilit dosyası --lockfile_mode işaretiyle kontrol edilebilir. Kullanılabilen modlar şunlardır:

• update (Varsayılan): Proje durumu kilit dosyasıyla eşleşirse çözüm sonucu kilit dosyasından hemen döndürülür. Aksi takdirde çözüm uygulanır ve kilit dosyası mevcut durumu yansıtacak şekilde güncellenir.
• error: Proje durumu kilit dosyasıyla eşleşirse çözüm sonucu kilit dosyasından döndürülür. Aksi takdirde Bazel, proje ile kilit dosyası arasındaki farklılıkları belirten bir hata verir. Bu mod, özellikle projenizin bağımlılıklarının değişmediğinden ve farklılıkların hata olarak değerlendirildiğinden emin olmak istediğinizde yararlıdır.
• off: Kilit dosyası hiç kontrol edilmemiştir.

Kilit Dosyasının Avantajları

Kilit dosyası çeşitli avantajlar sunar ve çeşitli şekillerde kullanılabilir:

• Yeniden oluşturulabilir derlemeler. Kilit dosyası, yazılım kitaplıklarının belirli sürümlerini veya bağımlılıklarını yakalayarak derlemelerin farklı ortamlarda ve zaman içinde yeniden üretilebilir olmasını sağlar. Geliştiriciler, projelerini oluştururken tutarlı ve tahmin edilebilir sonuçlara güvenebilir.

• Etkili çözünürlük atlama. Kilit dosyası, son derlemeden bu yana proje bağımlılıklarında değişiklik yoksa Bazel'in çözüm sürecini atlamasını sağlar. Bu, özellikle çözümün zaman alıcı olabildiği senaryolarda derleme verimliliğini önemli ölçüde artırır.

• Kararlılık ve risk azaltma. Kilit dosyası, beklenmeyen güncellemeleri önleyerek veya harici kitaplıklarda değişiklikleri bozarak kararlılığı korumaya yardımcı olur. Bağımlılıkları belirli sürümlere kilitleyerek, uyumsuz veya test edilmemiş güncellemelerden kaynaklanan hata oluşması riskini azaltır.

Kilit Dosyası İçerikleri

Kilit dosyası, proje durumunun değişip değişmediğini belirlemek için gerekli tüm bilgileri içerir. Ayrıca projeyi mevcut haliyle kurmanın sonucunu da içerir. Kilit dosyası iki ana bölümden oluşur:

1. Modül çözünürlüğünün (moduleFileHash, flags ve localOverrideHashes gibi) girişleri ve moduleDepGraph olan çözünürlük çıkışı.
2. Her modül uzantısı için kilit dosyası, transitiveDigest ile temsil edilen ve uzantıyı etkileyen girişleri ve generatedRepoSpecs olarak adlandırılan uzantının çalıştırılmasının çıktısını içerir.

Aşağıda, kilit dosyasının yapısını ve her bölümün açıklamalarını gösteren bir örnek verilmiştir:

{
  "lockFileVersion": 1,
  "moduleFileHash": "b0f47b98a67ee15f9.......8dff8721c66b721e370",
  "flags": {
    "cmdRegistries": [
      "https://bcr.bazel.build/"
    ],
    "cmdModuleOverrides": {},
    "allowedYankedVersions": [],
    "envVarAllowedYankedVersions": "",
    "ignoreDevDependency": false,
    "directDependenciesMode": "WARNING",
    "compatibilityMode": "ERROR"
  },
  "localOverrideHashes": {
    "bazel_tools": "b5ae1fa37632140aff8.......15c6fe84a1231d6af9"
  },
  "moduleDepGraph": {
    "<root>": {
      "name": "",
      "version": "",
      "executionPlatformsToRegister": [],
      "toolchainsToRegister": [],
      "extensionUsages": [
        {
          "extensionBzlFile": "extension.bzl",
          "extensionName": "lockfile_ext"
        }
      ],
      ...
    }
  },
  "moduleExtensions": {
    "//:extension.bzl%lockfile_ext": {
      "transitiveDigest": "oWDzxG/aLnyY6Ubrfy....+Jp6maQvEPxn0pBM=",
      "generatedRepoSpecs": {
        "hello": {
          "bzlFile": "@@//:extension.bzl",
          ...
        }
      }
    }
  }
}

Modül Dosya Karması

moduleFileHash, MODULE.bazel dosya içeriğinin karma değerini gösterir. Bu dosyada herhangi bir değişiklik olursa karma değeri farklı olur.

Bayraklar

Flags nesnesi, çözüm sonucunu etkileyebilecek tüm işaretleri depolar.

Yerel Geçersiz Kılma Karmaları

Kök modülde local_path_overrides varsa bu bölümde MODULE.bazel dosyasının karma değeri yerel depoda depolanır. Bu bağımlılıktaki değişikliklerin izlenmesine olanak tanır.

Modül Bağımlılığı Grafiği

moduleDepGraph, yukarıda belirtilen girişlerin kullanıldığı çözüm sürecinin sonucunu temsil eder. Projeyi yürütmek için gereken tüm modüllerin bağımlılık grafiğini oluşturur.

Modül Uzantıları

moduleExtensions bölümü, yalnızca mevcut çağrıda kullanılan veya daha önce çağrılan uzantıları içeren bir haritadır ancak artık kullanılmayan uzantıları hariç tutar. Başka bir deyişle, bağımlılık grafiğinde artık kullanılmayan uzantılar moduleExtensions haritasından kaldırılır.

Bu haritadaki her giriş, kullanılan bir uzantıya karşılık gelir ve içerdiği dosya ve adla tanımlanır. Her girişin karşılık gelen değeri, ilgili uzantıyla ilişkili alakalı bilgileri içerir:

1. transitiveDigest, uzantı uygulamasının ve onun geçişli .bzl dosyalarının özetidir.
2. Söz konusu uzantının geçerli girişle çalıştırılmasının sonucu generatedRepoSpecs.

Uzantı sonuçlarını etkileyebilecek diğer bir faktör de kullanımlarıdır. Kilit dosyasında depolanmasa da uzantının mevcut durumu kilit dosyasındaki durumla karşılaştırılırken kullanımlar dikkate alınır.

En İyi Uygulamalar

Kilit dosyası özelliğinin avantajlarından en iyi şekilde yararlanmak için aşağıdaki en iyi uygulamalardan yararlanabilirsiniz:

• Kilit dosyasını, proje bağımlılıkları veya yapılandırmadaki değişiklikleri yansıtacak şekilde düzenli olarak güncelleyin. Bu sayede, sonraki derlemeler en güncel ve doğru bağımlılık grubuna dayanır.

• Ortak çalışmayı kolaylaştırmak ve tüm ekip üyelerinin aynı kilit dosyasına erişebilmesini sağlamak için kilit dosyasını sürüm kontrolüne dahil edin. Böylece proje genelinde tutarlı geliştirme ortamları oluşturabilirsiniz.

Bu en iyi uygulamaları izleyerek Bazel'deki kilit dosyası özelliğini etkili bir şekilde kullanarak daha verimli, güvenilir ve ortak çalışmaya dayalı yazılım geliştirme iş akışları elde edebilirsiniz.