ca99241843
---ci--- project: acdl phase: 28-38 milestone: v1.8 status: verify lessons: - P0 fix: pipelines/deploy.yaml stale terraform/spike paths updated to run_platform.sh - P1 fix: removed import sys from inside _emit_resource function body - P1 fix: removed unused cpu/memory vars in uptime emission - P1 fix: decommission consumerRepo now uses GITHUB_REPOSITORY env ---/ci--- P0: deploy.yaml 3 stage commands referenced removed terraform/spike dir. P1 fixes: import sys, unused vars, consumerRepo env. P1 flagged: uptime hardcoded subnet/sg, uses ref not bumped to v1.8. P2 flagged: deploy-uptime flag standalone, pre-v1.8 READMEs missing NFRs. Tests: 350 passed.
ACDL Pipelines
Overview
ACDL uses declarative pipeline contracts (YAML) as the single source of truth. Both Gitea and GitHub workflows implement the same contract (byte-identical). The shell runner (scripts/run_ci.sh) mirrors the CI pipeline locally so that every stage that runs in CI can be reproduced on a developer machine without a forge.
Existing Pipelines
| Pipeline | File | Stages | Triggers |
|---|---|---|---|
| ACDL CI | ci.yaml |
lint, test, check-only |
push/PR to main |
| ACDL Deploy | deploy.yaml |
validate-contract, resolve-stack, terraform-plan, checkov, confidence, apply, publish-outputs, deploy-uptime, comment-outputs |
push/PR to main (consumer repos via workflow_call) |
How to Write a Pipeline
- YAML structure:
name,environment,triggers(withpushandpull_requestbranch arrays),runner,python_version, and astages[]list. - Each stage is an object with
name,command,required(boolean), and optionalinstall(pip install command) +description(human-readable summary). - Validate the resulting YAML against
schemas/pipeline.schema.json(CI) orschemas/deploy-pipeline.schema.json(deploy).
How to Wire a Pipeline
- Create byte-identical workflow YAMLs in
.gitea/workflows/<name>.ymland.github/workflows/<name>.yml. - Both workflows must implement the same stages, commands, triggers, and runner declared in the contract.
scripts/run_ci.shmirrorsci.yamllocally so the same stages run without a forge.- Consumer repos reference the deploy pipeline via
uses: acdl/.github/workflows/deploy.yml@vX.Y.
Dependencies
scripts/run_ci.sh— local CI mirror that runs theci.yamlstages.scripts/run_platform.sh— platform pipeline runner that implements thedeploy.yamlstages.- Workflow YAMLs in
.gitea/workflows/and.github/workflows/. - Schemas in
schemas/(pipeline.schema.json,deploy-pipeline.schema.json).
How to Test Pipelines
tests/test_pipeline_contract.py— validates each pipeline YAML against its schema, asserts workflow conformance (byte-identical Gitea/GitHub workflows with the same stages/commands/triggers), and testsscripts/run_ci.shexecution against the contract.
Adding a New Pipeline
- Create
pipelines/<name>.yamlusing the structure above. - Create or extend the schema in
schemas/for the new pipeline shape. - Create byte-identical workflow YAMLs in
.gitea/workflows/<name>.ymland.github/workflows/<name>.yml. - Extend
scripts/run_ci.shif a local mirror of the new pipeline is needed. - Write or extend tests in
tests/test_pipeline_contract.pyto assert schema validity and workflow conformance.