Огляд шаблонів
Автори сутностей Recipe і FeatureRecipe пишуть код Go text/template у визначених місцях обчислення: записи provides, записи locals, valuesMapping (вбудовано або завантажено через $import:), вміст workload: (вбудовано або завантажено через $import:), записи artifacts: (вбудовано або завантажено через $import: для кожного запису), injectMapping сутності FeatureRecipe, source:, записи assertions:, а також with: і when: кожного кроку pipeline:. Кожне місце виконується на визначеній фазі конвеєра компіляції та отримує визначене подання контексту стовпів. Цей набір розділів документує поверхню шаблонів: де виконуються шаблони, що контекст надає в кожному місці та які допоміжні функції доступні.
Форма контексту шаблону та порядок обчислення є несучими контрактами — зміна будь-якого з них ламає кожен наявний шаблон сутності Recipe. Контекст шаблону формально визначено в JSON Schema, що постачається разом із компілятором; матриця обчислення за місцями описує, які стовпи доступні для читання в якому місці, а рушій шаблонів Go постачається з бібліотекою допоміжних функцій Sprig і розширеннями, специфічними для Aggrega. Етапи конвеєра, до яких прив’язані ці місця обчислення, описано на архітектурному рівні в ../architecture/10-compilation-pipeline.md — inject mapping для injectMapping сутності FeatureRecipe, преамбула locals і розв’язання джерела для .locals і .source сутності Recipe, базовий рендеринг для valuesMapping базової сутності Recipe та рендеринг функцій для генерації ресурсів сутності FeatureRecipe.
Довідка за темами
- Матриця розгортання шаблонів — авторитетна таблиця за місцями, що охоплює кожну точку обчислення шаблонів, стовпи, які читає місце, і те, як виходи потрапляють у граф IR або в подальші підпроходи.
- Контракт контексту шаблону — формальна форма контексту шаблону, який компілятор передає шаблонам, зокрема двостанова пара
.inject/.inject_rawі збагачена проєкція JOIN.context.uses. - Іменування відрендереного ресурсу — який із двох ключів ідентичності що іменує, різниця між ціллю
usesі посиланням, яке публікує виробник, які провайдери повідомляють ім’я для ресурсів, що вони рендерять, і чому інші його не повідомляють, а також зупинка, що відхиляє ключ там, де такого імені немає. - Функції та допоміжні засоби Sprig — допоміжні функції Sprig, доступні в шаблонах Go, а також розширення, специфічні для Aggrega, і допоміжні функції безпеки; як записане автором число читається, виводиться й порівнюється в шаблоні значення; які допоміжні функції перевіряють, чи значення було записано, а які — чи воно порожнє.
- Контекст шаблону для параметрів — де значення
parameters:, заповнені сутністю Release, потрапляють до шаблону: їх підставляють у шаблони значень до виконання, а безпосередньо читають лише шаблони шляхів. - Блок
assertions:— іменовані міжпольові правила, які сутність Component, Feature, Recipe або FeatureRecipe оголошує як шаблони; їх обчислюють перед рендерингом.