up
This commit is contained in:
@@ -17,8 +17,10 @@ CI module collects reproducible pipeline recipes for builds, tests, and release
|
||||
## Operational notes
|
||||
- Encourage reuse through templated YAML/JSON fragments.
|
||||
|
||||
## Related resources
|
||||
- ./recipes.md
|
||||
## Related resources
|
||||
- ./recipes.md
|
||||
- ./TASKS.md (status mirror)
|
||||
- ../../implplan/SPRINT_0315_0001_0001_docs_modules_ci.md (sprint tracker)
|
||||
|
||||
## Backlog references
|
||||
- CI recipes refresh tracked in ../../TASKS.md under DOCS-CI stories.
|
||||
|
||||
14
docs/modules/ci/TASKS.md
Normal file
14
docs/modules/ci/TASKS.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# CI Recipes task board
|
||||
|
||||
Keep this table in sync with `docs/implplan/SPRINT_0315_0001_0001_docs_modules_ci.md`. Use TODO → DOING → DONE/BLOCKED.
|
||||
|
||||
| Task ID | Status | Owner(s) | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| CI RECIPES-DOCS-0001 | DONE | Docs Guild | Module charter docs (AGENTS/README/architecture/implementation_plan) refreshed with determinism + offline posture. |
|
||||
| CI RECIPES-ENG-0001 | DONE | Module Team | TASKS board established; status mirroring rules documented. |
|
||||
| CI RECIPES-OPS-0001 | DONE | Ops Guild | Sprint normalized/renamed; legacy stub retained; statuses mirrored. |
|
||||
|
||||
## Status rules
|
||||
- Update both this file and the relevant sprint entry whenever task status changes.
|
||||
- Keep timestamps in UTC ISO-8601; sort new rows deterministically by Task ID.
|
||||
- Document any contract/runbook changes in the module docs under this directory and link them from the sprint Decisions & Risks section.
|
||||
@@ -1,7 +1,25 @@
|
||||
# CI Recipes architecture
|
||||
|
||||
> Reference the AOC guardrails, export workflows, and notification patterns documented in the Authority, Export Center, and Notify module guides when designing CI templates.
|
||||
|
||||
This placeholder summarises the planned architecture for CI Recipes. Consolidate design details from implementation plans and upcoming epics before coding.
|
||||
|
||||
Refer to the module README and implementation plan for immediate context, and update this document once component boundaries and data flows are finalised.
|
||||
# CI Recipes architecture
|
||||
|
||||
## Scope & responsibilities
|
||||
- Curate deterministic CI pipeline templates for ingestion, scanning, policy evaluation, export, and notifications.
|
||||
- Capture provenance for each recipe (inputs, pinned tool versions, checksum manifests) and keep offline/air-gap parity.
|
||||
- Provide reusable fragments (YAML/JSON) plus guardrails (AOC checks, DSSE attestation hooks, Rekor/Transparency toggles).
|
||||
|
||||
## Components
|
||||
- **Recipe catalogue (`recipes.md`)** — Source of truth for pipeline snippets; sorted deterministically and annotated with required secrets/scopes.
|
||||
- **Guardrail hooks** — Inline steps for schema validation, SBOM/VEX signing, and attestation verification; reuse Authority/Signer/Export Center helpers.
|
||||
- **Observability shim** — Optional steps to emit structured logs/metrics to Telemetry Core when allowed; defaults to no-op in sealed/offline mode.
|
||||
- **Offline bundle path** — Scripts/guides to package recipes and pinned tool archives for air-gapped runners; hashes recorded in release notes.
|
||||
|
||||
## Data & determinism
|
||||
- All generated artifacts (templates, manifests, example outputs) must sort keys and lists, emit UTC ISO-8601 timestamps, and avoid host-specific paths.
|
||||
- DSSE/attestation helpers should target the platform trust roots defined in Authority/Sigstore docs; prefer BLAKE3 hashing where compatible.
|
||||
- Keep retry/backoff logic deterministic for reproducible CI runs; avoid time-based jitter unless explicitly documented.
|
||||
|
||||
## Integration points
|
||||
- Authority/Signer for DSSE + Rekor publication; Export Center for bundle assembly; Notify for preview hooks; Telemetry Core for optional metrics.
|
||||
- Recipes must remain compatible with CLI/SDK surface referenced in `docs/modules/cli/guides/` and devportal snippets.
|
||||
|
||||
## Change process
|
||||
- Track active work in `docs/implplan/SPRINT_0315_0001_0001_docs_modules_ci.md` and mirror statuses in `./TASKS.md`.
|
||||
- When adding new recipes, include offline notes, determinism checks, and minimal test harness references in `docs/benchmarks` or `tests/**` as applicable.
|
||||
|
||||
@@ -15,7 +15,8 @@
|
||||
- **Epic 11 – Notifications Studio:** document CI hooks for notification previews/tests.
|
||||
- Track DOCS-CI stories in ../../TASKS.md.
|
||||
|
||||
## Coordination
|
||||
- Review ./AGENTS.md before picking up new work.
|
||||
- Sync with cross-cutting teams noted in `/docs/implplan/SPRINT_*.md`.
|
||||
- Update this plan whenever scope, dependencies, or guardrails change.
|
||||
## Coordination
|
||||
- Review ./AGENTS.md before picking up new work.
|
||||
- Sync with cross-cutting teams noted in `/docs/implplan/SPRINT_*.md`.
|
||||
- Mirror task status changes in `./TASKS.md` and the owning sprint file.
|
||||
- Update this plan whenever scope, dependencies, or guardrails change; record deterministic/offline considerations with each recipe addition.
|
||||
|
||||
Reference in New Issue
Block a user