kollect-render

README

kollect-render

Credential-free CLI that validates versioned inventory documents and renders them to deterministic artifacts (markdown, confluence-storage, and more as the format registry grows). File outputs include a .meta.json digest/metadata sidecar for private publishers; this tool never opens network connections or holds publish credentials.

This repository is the public Open Source renderer for the PlatformRelay inventory protocol. Collection, scheduling, credentials, and publishing stay in private callers; this tool only transforms documents you already have.

Status

OSS renderer with kollect-parity quality gates (lint, arch-lint, coverage ≥90%, gitleaks, REWE-trace). Tagged releases (vX.Y.Z) publish multi-platform binaries and a GHCR container image via GoReleaser. validate and render are available; output formats register at compile time (markdown, confluence-storage). Writing --output <file> emits <file>.meta.json (content digest + generation metadata) for the private publisher contract.

Quick start

task check          # fmt, vet, lint, arch-lint, coverage≥90%, gitleaks, build, REWE-trace
go run ./cmd/kollect-render version
# Built-in Model → encoder (any registered format):
go run ./cmd/kollect-render render --format markdown --context test/golden/env-inventory-md/context.yaml
go run ./cmd/kollect-render render --format confluence-storage --context test/golden/env-inventory-md/context.yaml
# Custom markdown template ( --format must be markdown ):
go run ./cmd/kollect-render render --format markdown --template test/golden/env-inventory-md/template.md.tmpl \
  --context test/golden/env-inventory-md/context.yaml

Requires Go (see go.mod), Task, and gitleaks on PATH for the secret-scan step of task check.

Install

Release artifacts (binaries + container) are published on each vX.Y.Z tag:

# Binary (example): download from GitHub Releases
# Container:
docker pull ghcr.io/platformrelay/kollect-render:v0.1.0

Pin the image or release asset by version; Renovate can track the GitHub Releases / GHCR datasources.

CLI

Command / flag	Role
validate <document>	Schema-validate an inventory document; exit 0 ok / 2 fatal
render	Deterministic render; exit 0 ok / 2 fatal
--format	markdown or confluence-storage (default markdown)
--context	RenderContext YAML/JSON (required)
--template	Optional markdown text/template (markdown format only)
--output	Body path, or - / omit for stdout (file output also writes .meta.json)
--upstream-deps	Replace Upstream with a map[componentID]UpstreamEntry YAML file
--generated-at	Override Generation.GeneratedAt (RFC3339 UTC)
--report-origin	Override Generation.Origin (e.g. schedule, manual, ci)

Completeness / catalog policy stays with the private aggregator; this CLI only applies the flags above to an already-shaped render context.

Golden tests

Fixture → expected output suites live under test/golden/. To regenerate committed goldens after an intentional render change:

UPDATE_GOLDEN=1 go test ./internal/format/ ./internal/render/

Review the golden diff like code before committing.

License

MIT