kollect-render

Credential-free inventory renderer. Validate versioned inventory documents and render them to deterministic artifacts (markdown, confluence-storage, …). File outputs include a .meta.json digest/metadata sidecar for private publishers. This tool never opens network connections or holds publish credentials.

Collection, scheduling, credentials, and publishing stay in private callers; this repository is the public Open Source renderer for the PlatformRelay inventory protocol.

Docs: platformrelay.github.io/kollect-render — getting started, CLI reference, formats, schema, and development. This README is the front door; the site is the map.

Quick start

task check          # fmt, vet, lint, arch-lint, coverage≥90%, gitleaks, build, REWE-trace, pinned-actions
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.

Documentation

• Site: platformrelay.github.io/kollect-render
• Getting started · CLI reference · Formats · Schema · Development · Security

Golden fixtures live under test/golden/. Regenerate after an intentional render change with UPDATE_GOLDEN=1 go test ./internal/format/ ./internal/render/, then review the diff like code.

Status

Gate-verified facts (not aspirational):

• Local gate task check: fmt, vet, lint, arch-lint, module coverage ≥90%, gitleaks, build, REWE-trace, pinned Actions.
• CI runs the same gate; Codecov publishes coverage; CodeQL and OpenSSF Scorecard are published.
• Docs build and deploy to GitHub Pages from .github/workflows/docs.yaml.
• Tagged releases (vX.Y.Z) publish multi-platform binaries and a GHCR image via GoReleaser.
• validate and render are available; formats register at compile time (markdown, confluence-storage). Writing --output <file> emits <file>.meta.json.
• SonarCloud analysis runs in CI on every push/PR. The Quality Gate badge is deferred: QG is still ERROR on new_duplicated_lines_density (OD-3 revisit — do not advertise a failing gate).

License

MIT