aggrega pin
aggrega pin <entity-path>, bir Recipe veya FeatureRecipe’in yanındaki entity.lock dosyasına, varlığın kendi belgesi dışından okuduğu her girdi için içerik sabitlemesini kaydeder. Bu, varlık yazarının adımıdır: varlık tüketilmeden veya yayımlanmadan önce çalıştırın ve yazdığı kilit dosyasını commit edin.
aggrega pin catalog/recipe/helm/server/1.0.0/recipe.yamlNeleri kaydeder
Bir varlık kendi belgesinin dışındaki baytlara bağlı olabilir ve kilit dosyası bunların her biri için bir sabitleme tutar:
- Koordinatlarını eksiksiz yazdığınız uzak bir
source:—kind,url,chart,module_subdir,versionveyarefalanlarının hiçbirinde şablon yoktur. Adım onu getirir ve çözümlendiği sürümü — bir git kaynağı içinrefalanının adlandırdığı commit’i — ve getirilen içeriğin özetini kaydeder. - Bir
artifactsgirdisinin$importile içe aktardığı dosya. Adım, dosyanın çalışma alanınızdaki hâlinin özetini alır. - Varlığın yanındaki bir dizini veya dosyayı adlandıran bir
source:kaynağının her dosyası. Hiçbir şey getirilmez: adım, kaynağın varlığın bir yayınının taşıdıklarına kattığı her dosyanın — adlandırdığı dizin altında varlığın yok sayma kurallarının tuttuğu her dosyanın ya da o tek dosyanın — özetini alır ve onu varlığın yanındaki yoluyla kaydeder. Recipe’nin yanında olup kaynağın katkıda bulunmadığı bir dosya, örneğin bir README, sabitlenmez../charts/{{ .values.flavour }}gibi şablon olarak yazılmış bir kaynak, dizinini ancak bir Release onu doldurduğunda adlandırır; bu nedenle varlığın dizininde kuralların tuttuğu her dosyaya katkıda bulunur ve bunların her biri sabitlenir. Bir derleme, sağlayıcısı kaynağı okumadan önce kaynağı bu sabitlemelerle karşılaştırır; dolayısıyla sabitlemeden bu yana eklenen, değiştirilen veya kaldırılan bir dosya derlemeyi durdurur — A local source no longer matches the pins recorded beside its Recipe (Yerel bir kaynak artık Recipe’sinin yanında kaydedilen sabitlemelerle eşleşmiyor). - Dizin olan bir
source:için yok sayma kurallarının kendisi. Adım, varlığın yeteneğine hangi eklentinin hizmet ettiğini ve onun oluşturduğu kuralların tam hâlini, sonraki bölümde açıklandığı gibi kaydeder.
Kaydetmedikleri: koordinatları bir şablondan doldurulan uzak bir kaynak — bu kaynak bir yapıtı ancak bir Release onu doldurduğunda adlandırır ve her Release’in kilit dosyasında aggrega pull tarafından sabitlenir; ve satır içi bir artifacts girdisi ya da bir ArtifactLibrary’den alınan girdi. Dosyanın kendisi varlık kilidi şemasında alan alan açıklanır.
Release gerekmez. Eksiksiz yazılmış bir kaynak, varlığı kullanacak her Release için aynı yapıtı adlandırır; dolayısıyla onu çözümlemek bir Release’in sağladığı hiçbir şeye ihtiyaç duymaz. Bir yazarın, hiç Release bulunmayan bir çalışma alanında bir varlığı sabitleyebilmesini sağlayan budur.
Varlık dosyasına asla yazılmaz. Adımın türettikleri varlığın yanına gider; yazdıklarınız tam olarak yazdığınız gibi bırakılır. Değişmemiş girdiler üzerinde yeniden çalıştırmak kilidi bayt bayt aynı bırakır ve bir kilidin kaydettiği hiçbir şeyi artık okumayan bir varlığın kilidi kaldırılır. Böyle bir girdi okumayan bir Component, bir Feature veya başka herhangi bir tür, sabitlenecek bir şeyi olmadığı şeklinde raporlanır ve yanındaki hiçbir şeye dokunulmaz.
Bir varlıkla birlikte hangi dosyalar gönderilir
source: alanı yanındaki bir dizini — birlikte konumlanmış bir chart, bir modül — adlandıran bir Recipe veya FeatureRecipe, yayımlandığında o dizinin dosyalarını taşır. İçindeki her dosya oraya ait değildir: bir sürüm denetimi dizini, bir bağımlılık önbelleği, bir düzenleyicinin artıkları. Hangi dosyaların ait olduğuna .gitignore sözdizimindeki yok sayma kuralları karar verir ve bunları siz denetlersiniz. Bu kurallar iki yerden gelir:
- Varlığın yeteneğini işleyen eklenti, kendi ekosisteminin hiçbir zaman göndermediği şeyleri bildirir. Chart eklentileri sürüm denetimi dizinlerini (
.git/,.hg/,.svn/,.bzr/) ve bir chart’ıntemplates/dizini altındaki gizli dosyaları dışarıda bırakır ve chart’ın kendi.helmignoredosyasına uyar: kaynağın taranması nerede böyle bir dosyayla karşılaşırsa, satırları onu içeren dizin için ek kurallar olarak okunur. Terraform eklentisi sürüm denetimi dizinlerini ve.terraform/çalışma dizinini dışarıda bırakır — modülle birlikte taşınması amaçlanan bağımlılık kilit dosyasını değil — ve.terraformignoredosyasına aynı şekilde uyar. Hiçbir şey bildirmeyen bir eklenti her şeyi içeride bırakır. - Kendi
.aggregaignoredosyanız: varlık belgesinin yanında, aynı sözdizimindeki tek bir dosya. Satırları eklentininkilerden ve eklentinin adlandırdığı her yok sayma dosyasından sonra uygulanır; böylece adlandırdığınız herhangi bir yol üzerinde son sözü siz söylersiniz:.venv/gibi bir satır eklentinin hiçbir şey bilmediği bir dizini dışarıda bırakır,!.git/gibi bir satır ise eklentinin dışarıda bıraktığı birini geri getirir. Dosyanın kendisi hiçbir zaman taşınmaz; kuralları kilidin içinde taşınır.
.venv/*.bak!notes.bakHer kural ait olduğu dizine göreli olarak okunur. Eklentinin bildirdiği bir kural kaynak dizininin kökünden; bir .helmignore satırı o dosyayı içeren dizinden; sizin .aggregaignore dosyanızın bir satırı ise varlığın kendi dizininden okunur. Eğik çizgi içermeyen ya da yalnızca sonda eğik çizgi bulunan bir kural herhangi bir derinlikteki bir adla eşleşir; sondaki eğik çizgi yalnızca bir dizinle eşleşir; baştaki ! daha önceki bir kuralın dışarıda bıraktığını geri getirir. Bir kuralın dışarıda bıraktığı bir dizine girilmez; bu nedenle içindeki bir dosya ancak dizinin kendisi geri geldiğinde geri gelir — .git/ dışarıda bırakıldığı sürece yalnızca !.git/HEAD dosyayı geri getirmez, !.git/ ise getirir.
Kuralları okunan eklenti, sabitleme yaptığınızda çalışma alanınızda yeteneğe hizmet eden eklentidir: çalışma alanınızın o yetenek için sağlayıcı bağlaması ya da bu yoksa aggrega içine yerleşik eklenti. Adım bu eklentiyi provider/terraform gibi yalnızca adıyla, sürüm olmadan, ve oluşturduğu kuralların tam hâlini entity.lock içine kaydeder; eklentisi aynı kuralları bildiren daha yeni bir aggrega ile yeniden sabitlemek kilidi değiştirmez. O andan itibaren dizinin her okunuşu kaydedilen kuralları uygular ve başkasını uygulamaz: varlığın bir yayını, bir çekme ya da gönderme işleminin kilide karşı yaptığı karşılaştırma, varlığın bir kilit dosyasındaki satırı, bir derlemenin karşılaştırması, dizini bir sağlayıcıya veren işleme ve aggrega pull --verify. Böylece yayımladığınız şey tam olarak kendi derlemenizin işlediği şeydir; değişen bir bağlama, düzenlenmiş bir .aggregaignore ya da daha yeni bir aggrega, siz yeniden sabitleyene kadar hiçbir şeyi değiştirmez — bu noktada kilidin farkı neyin değiştiğini gösterir. Bir eklentinin yok sayma dosyası olarak adlandırdığı, .helmignore gibi bir dosya da kaynağın dosyalarından biridir ve bir kural onu dışarıda bırakmadıkça diğerleri gibi sabitlenir; bu nedenle yeniden sabitlemeden onu düzenlemek bir sonraki çekme ya da derlemede yakalanır. Hiçbir kural kaydetmeyen bir kilit, dizin altındaki her dosyayı tutar.
Bir tüketici, kurallarınızın tuttuğu dosyaları işler. Bir eklenti, kendi yeteneği için yayımlanmış bir Recipe’i aynı ABI sürümünü konuştuğunda, sözleşmesi varlığının iddiasıyla eşleştiğinde ve yayımlanan kümenin dışında hiçbir dosyaya ihtiyaç duymadığında işleyebilir. Kümenin dışarıda bıraktığı bir dosyaya ihtiyaç duyan bir eklenti, derlemesini açıkça başarısız kılmalı ve dosyayı adlandırmalıdır; ana makinenin payına düşen ise kümenin taşımadığı bir dosyanın her türlü paketlenmesini ya da okunmasını, dosyayı adlandırarak reddetmektir. Bir tüketicinin çalışma alanının yetenek için bağladığı eklenti, kilidinizin kaydettiği kurallardan farklı kurallar bildirdiğinde, tüketicinin aggrega pull komutu bunu her iki eklentiyi ve farkı adlandıran bir uyarıyla bildirir ve devam eder.
Bir varlığın dosyaları arasındaki sembolik bağlantı reddedilir; nereyi gösterdiğine ve çözümlenip çözümlenmediğine bakılmaksızın — bkz. A symbolic link sits among the files an entity carries (Bir varlığın taşıdığı dosyalar arasında sembolik bir bağlantı bulunuyor). Kurallarınızın dışarıda bıraktığı bir bağlantı, dışarıda bıraktıkları diğer her dosya gibi atlanır. Varlığın adlandırdığı ve varlığın dizininin dışına çıkan bir bağlantı olan bir dizinden geçen yol da, herhangi bir şey sabitlenmeden önce reddedilir — bkz. A path names content outside the entity’s own directory (Bir yol, varlığın kendi dizininin dışındaki içeriği adlandırıyor).
Kilidin yazıldığı yer
Kilit, adını verdiğiniz belgenin yanına, aynı dizine yazılır; bu nedenle varlığın yazılabilir bir yuvaya, yani size ait bir dizindeki bir belgeye ihtiyacı vardır. Bir pull işleminin içerik önbelleğinden çözümlediği bir varlığın böyle bir yuvası yoktur ve hiçbir şey tarafından sabitlenmez.
Bir dizin, bir varlık. Bir dizin tek bir entity.lock barındırır; bu nedenle adım, dizinini başka herhangi bir varlıkla paylaşan bir Recipe veya FeatureRecipe’i, ikisinden birinin sabitlenecek bir şeyi olsun ya da olmasın, engel olan her varlığı adlandırarak reddeder; ret An entity shares its directory with another entity (Bir varlık dizinini başka bir varlıkla paylaşıyor) hatasıdır. Yan yana durabilen Aggregate, Release ve Manifest dışında her türün kendine ait bir dizini vardır; One entity per directory bölümünde açıklandığı gibi, bir push yayımladığı varlığı aynı kurala tabi tutar. Adım yalnızca kilit yazdığı şeyi değerlendirir; bu nedenle bir Component ya da sabitleyecek bir şeyi olmadığı başka herhangi bir tür, sabitlenecek bir şeyi yokmuş gibi raporlanır ve ret o varlığa yayımlandığında ulaşır. Varlığın yanında bulunan ve varlık belgesi olmayan bir dosya (bir chart dosyası, içe aktarılan dosyanın kendisi) engel oluşturmaz. Varlığın yanındaki her belge yalnızca çalışma alanının içinden ya da çalışma alanı dışında adını verdiğiniz bir belge için kendi dizininin içinden (kilidin de tutulduğu yer) okunur; bu nedenle dışarıya çıkan bir bağlantı olan bir belge, çalışma alanı sınırı bölümünde açıklandığı gibi, okunmadan bağlantıyı adlandırarak adımı durdurur.
Kim sabitler ve ne zaman
Sabitleme bir yazarlık görevidir. Girdileri sabitlenmemiş bir varlık henüz tüketilmeye hazır değildir; bu nedenle varsayılan olarak bir pull hiçbir sabitleme kaydetmez: Release’in derlediği, katalog dizinlerinizden birindeki bir Recipe ya da FeatureRecipe üzerinde bu adımın kaydedeceği şeyi kilidin tuttuğu şeyle karşılaştırır ve bir sabitleme eksik olduğunda ya da artık girdisiyle eşleşmediğinde durur. Durma; varlığı, her girdiyi ve bunun uzak bir kaynak, içe aktarılmış bir dosya ya da yerel bir kaynağın dosyası olup olmadığını ve bu komutu belirtir. Bu, An entity reads an input the lock beside it records no pin for (Bir varlık, yanındaki kilidin sabitleme kaydetmediği bir girdiyi okuyor) hatasıdır. Bir push, yayımladığı varlığı aynı karşılaştırmaya tabi tutar ve aynı durmayla reddeder; böylece bir varlık, kaydedilmemiş bir sabitlemeyle aggrega push aracılığıyla bir kayıt defterine ulaşamaz — Yayımlamadan önce sabitleme bunu açıklar. Yerel bir kaynak tek bir dosya kümesi olarak tutulur: hiçbirini kaydetmeyen bir kilit bir pull’u ya da push’u durdurur; sabitlemeden bu yana eklenen, değiştirilen ya da kaldırılan bir dosya da, diğer eksik ya da eskimiş sabitlemeler gibi, aynı şeyi yapar.
İlk pull’daki bir durmayı düzeltmek tüketicinin değil, her zaman yayımcının işidir. Başka birinin yazdığı bir kataloğu tükettiğinizde — örneğin kendi dizininizdeki bir kopyasını — ve oradaki bir varlık sabitlenmemişse, yazar bu adımı hiç çalıştırmamıştır. Çözümünüz onların dizinini elle düzenlemek değildir: aşağıdaki çalışma alanı anahtarını ayarlayın; böylece pull’larınız sabitlemeleri kendileri kaydeder.
İki komut bu aynı adımı sizin adınıza çalıştırır ve aynı baytları yazar:
aggrega pull --pin-sources, durmak yerine adımı Release’in derlediği varlıklar üzerinde çalıştırır.aggrega push --pin-sources, reddetmek yerine adımı varlık üzerinde onu paketlemeden önce çalıştırır; böylece yazdığı kilit yayımlanan şeyin bir parçası olur.
Her birinin, sabitlemeyi varsayılanı yapan bir çalışma alanı anahtarı vardır: pin_sources_at_pull ve pin_sources_at_push; ikisi de varsayılan olarak kapalıdır ve her biri yalnızca kendi komutunu yönetir. Bayrak, anahtarını her iki yönde de geçersiz kılar: --pin-sources, anahtar ne derse desin tek bir çalıştırma için sabitler, --pin-sources=false ise sabitlemez. Böylece sabitlemek üzere yapılandırılmış bir çalışma alanı, tek bir pull için durmayı yine geri alabilir. Kendi kilit dosyasını dolduran bir derleme bir pull’dur, dolayısıyla pin_sources_at_pull anahtarını izler. Anahtarlar yapılandırma başvurusunda açıklanmıştır.
Yayımlanmış bir varlığı değiştirme
En iyi uygulama: daha önce yayımladığınız bir varlıkta yapılan bir düzenleme yeni bir sürüme ve ardından bir sabitlemeye aittir; hiçbir zaman zaten yayında olan sürümün yeniden sabitlenmesine değil. Varlığı yeni bir sürüm dizinine kopyalayın, değişikliği orada yapın ve yeni sürüm üzerinde aggrega pin komutunu çalıştırın. Yayımlanmış sürüm, tam olarak yayımlandığı baytları tanımlamaya devam eder ve yeni sürüme geçen bir tüketici bunu bilerek yapar.
Ürün bunun bir yarısını zorunlu kılar: zaten yayımlanmış bir sürümde değiştirilmiş içeriğin yayımlanması reddedilir, böylece yayımlanmış bir sürüm sessizce değiştirilemez. Diğer yarısını ise kendi çalışma alanınızda zorunlu kılmaz. Bir düzenlemeden sonra mevcut bir sürümü yeniden sabitlemek bazen tam olarak doğru olandır (örneğin tek bir uygulama içinde tükettiğiniz ve yayımlamadığınız bir varlık), bu nedenle hiçbir şey sizi engellemez ve bu disiplini korumak size kalmıştır.
Diğer yüzeylerde aynı adım
Daemon bu adımı aggrega/pin olarak (aggrega serve), araç protokolü ise pin aracı olarak (aggrega mcp) sunar; ikisi de bu komutun yazdığı baytların aynısını yazar. Bir HTTP dinleyicisi üzerinden araç, çalışma alanının içine yazar ve bir varlığın kaynaklarının adlandırdığı ana makinelere erişir; bu nedenle onu çağırmak için çağıranın workspace-write kapsamına sahip olması gerekir — bir pull işleminin gerektirdiği yetkinin aynısı.
Ayrıca bakınız
- aggrega-pull.md — varlık kilidi, bir derlemenin onunla neyi karşılaştırdığı ve durdurma.
- aggrega-push.md — bir varlığın yayımlanması ve bir sürümün bir kez yayımlanması.
- configuration.md —
pin_sources_at_pullvepin_sources_at_push.
Kullanım
aggrega pin <entity-path> [flags]Açıklama
Record, in the entity.lock beside a Recipe or FeatureRecipe, the content pin for every inputthe entity reads from outside its own document: a remote source: whose coordinates you wrote outin full, a file an artifacts entry imports with $import, and each file of a local source:.
Pinning is the entity author's step. Run it on an entity before it is consumed — before youpublish it, and after every change to one of its inputs — and commit the entity.lock it writesbeside the entity. A pull over an entity whose lock does not record these pins halts and namesthis command, and so does a push of it; so does one whose local source has had a file added,changed or removed since it was pinned.
No Release is needed. A source whose coordinates carry no template names one artifact for everyRelease that uses the entity, so it is resolved and pinned here, with nothing supplied. A remotesource whose coordinates are filled in from a template is not pinned here: which artifact it names isdecided by each Release, and each identity it resolves to is pinned in that Release's lockfile.A source that names a directory beside the entity is not fetched: each file it contributes to whata publication of the entity carries is digested as it stands and pinned by its path, so a buildrefuses a file added, changed or removed after the pin. A local source written as a templatecontributes every file in the entity's directory, so each of those is pinned.
Which files a source directory contributes is decided here, once, and recorded. The step reads theignore rules the plugin serving the entity's capability declares — this workspace's provider bindingfor that capability, or else the plugin built into aggrega — together with the ignore files thatplugin names inside the source, such as a chart's .helmignore, and the .aggregaignore beside theentity, in gitignore syntax, whose lines come last and so have the final say. It records the pluginand the composed rules in the entity.lock, and every publication, pull, build and render of theentity applies the recorded rules and no others, so a changed binding or a newer binary movesnothing until you pin again. A symbolic link among the files is refused rather than followed.
The step writes beside the entity, so the entity needs a writable home: the document you name isread from its own directory and the lock lands next to it. The entity file itself is neverwritten to. Re-running over unchanged inputs leaves the lock byte-identical; an entity that readsnothing a lock records has its lock removed. A Component, a Feature or any other kind that readsno such input is reported as having nothing to pin, and nothing beside it is touched.
A directory holds one entity.lock, so the step refuses a Recipe or FeatureRecipe that shares itsdirectory with any other entity, naming the entity in the way, whether or not either has anythingto pin. Every kind has a directory of its own except Aggregate, Release and Manifest, which may sitside by side; a push holds the entity it publishes to the same rule.
aggrega pull --pin-sources and aggrega push --pin-sources run this same step on your behalf, andwrite the same bytes.Bayraklar
| Bayrak | Varsayılan | Açıklama |
|---|---|---|
--dry-run | false | Varlığın girdilerini çözümler ve adımın yazacağı entity.lock dosyasını yazmak yerine yazdırır: yolu ve içereceği içerik stdout’a gider, diskte hiçbir şey değişmez. Adımın bayt bayt aynı bırakacağı bir kilit yazdırılmaz. Çözümleme, aksi durumda nasıl çalışacaksa tam olarak öyle çalışır; bu nedenle içerik önbelleği yine dolar |