Перейти к основному содержимому

Что такое спецификация

dagstack/config-spec — нормативный источник истины по конфигурации в экосистеме dagstack. Он фиксирует, что должно выполняться в любой реализации (dagstack/config-python, dagstack/config-typescript, планируемый dagstack/config-go) — и почему именно так.

Чем раздел «Спецификация» отличается от руководств

РазделАудиторияЧто даёт
КонцепцииРазработчик приложенийОбъясняет, как конфигурация работает сегодня в терминах конкретного языка.
РуководстваРазработчик приложенийШаг за шагом проводит по типичной задаче.
Спецификация (этот раздел)Автор реализации / ревьюерОбъясняет, почему принято решение; фиксирует нормативные гарантии.

ADR

В v1.0 один ADR:

  1. ADR-0001: YAML-конфигурация с интерполяцией env — формат передачи, слои, интерполяция env, абстракция ConfigSource, модель ошибок, подписки, канонический JSON и артефакты спецификации.

Дополнительные ADR появятся по мере развития экосистемы (составные профили, параметризованные переопределения, валидационные webhook-вызовы и так далее).

Нормативный источник

Страницы этого раздела — описательное прозаическое резюме ADR. Формальный нормативный текст лежит в dagstack/config-spec. Если работаешь над изменениями внутри реализации, читай нормативную версию: она покрывает все edge case'ы, правила сериализации и требования к сообщениям об ошибках.

Как меняется спецификация

  1. Открой issue в dagstack/config-spec.
  2. Подай PR с новым ADR или ревизией существующего.
  3. Architect-review плюс sign-off от мейнтейнеров каждой реализации (каждая реализация подтверждает, что сможет выкатить изменение).
  4. После merge — обнови реализации и резюме в этом разделе.

Связанные спецификации