CI/CD Pipeline Diagram¶

The structural map of the build · validate · publish workflow that gates every change to the apothem ecosystem. This document installs the visualization surface; the concrete GitHub Actions workflow files and the release tooling land later under the production-readiness installation.

Pipeline shape¶

%%{ init: { "theme": "neutral" } }%%
%% verified: 2026-04-27 %%
%% provenance: pyproject.toml + scripts/dev/validate_ecosystem.py + scripts/dev/validate_hooks.py %%
%% cross-reference: docs/developer-guide.md (contributor workflow) %%
flowchart LR
    accTitle: CI/CD pipeline shape
    accDescr: Left-to-right flowchart of the apothem CI CD pipeline showing build, test, lint, type-check, security scan, docs build, package, sign, and publish stages with branch protection gates between them.
    subgraph Trigger["Trigger surface"]
        PR["Pull request opened or updated"]
        PUSH["Push to main"]
        TAG["Tag release vX.Y.Z"]
    end
    subgraph Static["Static analysis lane"]
        LINT["Ruff lint + format check"]
        TYPE["Mypy strict"]
        MD["markdownlint"]
        FRONT["Frontmatter validator"]
    end
    subgraph Test["Test lane"]
        PYTEST["pytest tests/hooks"]
        ECO["validate_ecosystem.py"]
        CHAOS["chaos_pass.py (release lane)"]
        BENCH["src/apothem/benchmarks/ (release lane)"]
    end
    subgraph Security["Security lane"]
        SECRETS["Secret scan"]
        SBOM["SBOM generation"]
        LICENSE["License audit"]
    end
    subgraph Publish["Publish lane (tags only)"]
        SIGN["Signed-tag verification"]
        ATTEST["Provenance attestation"]
        DOCS["Documentation site publish"]
        RELEASE["Release notes from CHANGELOG.md"]
    end
    PR --> Static
    PR --> Test
    PR --> Security
    PUSH --> Static
    PUSH --> Test
    PUSH --> Security
    TAG --> Static
    TAG --> Test
    TAG --> Security
    TAG --> Publish
    Static --> GATE{All lanes green?}
    Test --> GATE
    Security --> GATE
    GATE -->|yes| MERGE[Merge / publish]
    GATE -->|no| BLOCK[Block · surface failures · request fix]
    Publish --> MERGE

Lane roles¶

• Static analysis lane — fast feedback. Ruff covers Python style and a curated rule set; mypy enforces type discipline at strict; markdownlint policies the documentation surface; the frontmatter validator gates artifact-schema compliance for rules, skills, agents, and commands.
• Test lane — pytest tests/hooks exercises the hook runtime against the full event matrix; validate_ecosystem.py is the primary structural gate for cross-artifact consistency; chaos_pass.py and the per-class benchmark suite under src/apothem/benchmarks/ activate on the release lane to catch degradation under degraded inputs and runtime-budget regressions.
• Security lane — secret scanning catches accidental committed credentials; SBOM generation and license audits gate the supply-chain surface for any production-readiness install.
• Publish lane — runs only on tagged releases. Signed-tag verification confirms release-branch provenance; the documentation site publishes from docs/ to the GitHub Pages target; release notes derive from CHANGELOG.md Keep-A-Changelog format.

Concrete configuration¶

The actual workflow files (.github/workflows/ci.yml, .github/workflows/release.yml, etc.) install during the production-readiness ecosystem build-out. This diagram defines the canonical shape every future configuration mirrors.

Authoritative cross-references¶

• pyproject.toml — Ruff / mypy / pytest configuration source of truth.
• scripts/dev/validate_ecosystem.py — the primary cross-artifact gate.
• scripts/dev/validate_hooks.py — hook-specific structural validation.
• scripts/dev/chaos_pass.py — adversarial sweep of every configured hook.
• src/apothem/benchmarks/ — per-class runtime budget verifiers.
• docs/developer-guide.md — the operator-facing contributor workflow.
• CHANGELOG.md — release-note source.