IMPORTANT: Developer documentation for the current development branch. This content is unreleased, may change without notice, and must not be treated as Buildish release documentation.

Reference

This section contains stable contracts, schema references, glossary material, and other normative model documentation.

This section contains generated reference material for the typed Site Pipeline contracts and the surrounding normative design notes.

The generated contract reference is intentionally split across multiple pages so the field-level schema documentation remains readable.


Site Pipeline API and contract boundaries

This document defines the public contract boundaries for the Site Pipeline.

Staged output contract

This document defines the stable staged-tree contract consumed by renderers, deployment adapters, and other downstream tooling.

Security and trust model

This document defines the baseline security posture for the current model.

Threat model

Threat model for the Site Pipeline CLI, staged outputs, and supported trust boundaries.

Validation and `site-pipeline check`

For maintainer-facing notes about shared evaluation ownership, stage-gating, and the lower execution path reused by check, build, and watch, see code maintenance.

Flexible component publication model

This document proposes a more flexible component contract for a green-field Site Pipeline deployment.

Provider snapshot schema

This document defines a normalized input schema for external release providers. It complements the flexible publication model by making the provider boundary concrete without hard-coding Apache Trusted Releases (ATR) or any other provider into the core pipeline model.

Provider snapshot to staged metadata mapping

This document describes how normalized provider snapshot data should flow into staged metadata. It complements provider-snapshot-schema.md by answering not just what a provider may supply, but what the pipeline should emit for renderers.

Pipeline model glossary

This glossary defines the terms used across the flexible publication and provider-integration docs.

Authored input types

Consumer-owned and component-owned authored contract models.

Incremental bookkeeping types

Pipeline-internal emitted bookkeeping contracts stored under data/_pipeline/.

Pipeline file contract index

Generated contract-file tables for authored, provider, and emitted Site Pipeline schemas.

Pipeline model schema reference

This reference is generated from the Site Pipeline Pydantic models and checked-in reference metadata. Do not edit it by hand; regenerate it with make schemas.

Pipeline shared types reference

Generated scalar alias and enum reference for Site Pipeline contracts.

Planning and stage-contract types

Pipeline-emitted planning, diagnostics, and stage-manifest contracts.

Provider input types

Normalized provider snapshot contracts consumed by the pipeline.

Staged aggregate metadata types

Public aggregate JSON contracts emitted under data/.

Staged front matter types

Front matter and page-level metadata emitted into staged content.