Jon Chery
dca35c78ec
---ci---
phase: 22
title: rename-and-production-static-assets-stack
status: complete
verification:
- scripts/run_ci.sh: PASS (CI PIPELINE OK)
- python3 -m pytest tests/ -v: 175 passed
- scripts/run_platform.sh --check-only: PASS (PLATFORM CHECK OK)
- grep -R "static-asset[^s]" . (excl .git/): 0 hits
- grep -R "static-asset$" . (excl .git/): 0 hits
- floating git tags v1.6 + v1 point at v1.6.0 (a90a756)
changed_files:
- Task 1 (rename): contracts/static-asset.yaml→static-assets.yaml (git mv); modules/l2/static-asset→static-assets (git mv); sed replaceAll static-asset→static-assets in 22 files (README, docs, scripts/run_platform.sh, pipelines/deploy.yaml, modules/registry.json, tests/*, .ciagent/* historical narrative)
- Task 2 (cloudfront primitive): modules/l1/cloudfront/interface.json + README.md
- Task 3 (waf primitive): modules/l1/waf/interface.json + README.md
- Task 4 (registry): modules/registry.json (+cloudfront, +waf, static-assets renamed)
- Task 5 (augment static-assets): modules/l2/static-assets/composition.json (s3+cloudfront+waf, depth 1); modules/l1/s3/interface.json +instance.json (+bucket_regional_domain_name output); modules/l2/static-assets/README.md (production stack docs)
- Task 6 (adapter): adapters/terraform/adapter.py (+TYPE_MAP/INPUT_MAP/OUTPUT_MAP for cloudfront distribution+OAC+wafv2 webacl; special handling in _emit_resource for OAC defaults, distribution origin/cache_behavior/restrictions/viewer_certificate/web_acl_id, waf scope/default_action/visibility_config/managed rules)
- Task 7 (contract schema): no change needed (generic inputs object; new module names match ^[a-z][a-z0-9-]*$)
- Task 8 (@v1.6 bump): contracts/static-assets.yaml, .gitea/.github/workflows/deploy.yml (ref: v1.6 + header comments), docs/consumer-guide.md, docs/contracts/index.md, docs/pipeline/versioning.md, docs/pipeline/index.md, docs/architecture.md, README.md, modules/l2/microservice/README.md, tests/test_environment_check.py, tests/test_pipeline_contract.py
- Task 9 (floating tags): git tag -f v1.6 v1.6.0; git tag -f v1 v1.6.0
- Task 10 (tests): tests/test_adapter.py (registry 11 entries/9 L1/2 L2; cloudfront+waf type map tests; TestS3Output bucket_regional_domain_name; TestStaticAssetsStack 4 tests); tests/test_contract_resolver.py (+s3/cloudfront/waf resource assertions)
generated:
- terraform/spike/main.tf + terraform.tf (regenerated by run_platform.sh --check-only; reflect static-assets production stack + backend key spike/static-assets/)
notes:
- D-048 full rewrite of .ciagent/ historical narrative (verbatim phase descriptions, REQ-25/27/50, D-036) — produces intentional tautologies (e.g. "Rename static-assets → static-assets") per the decision to override the v1.6 preservation precedent.
- cloudfront interface.json resources array ordered distribution-first so the resolver (first-match wire resolution) routes bucket_regional_domain_name/waf_web_acl_arn/region to the distribution; the OAC gets adapter-provided defaults (name=acdl-oac, origin_type=s3, signing_behavior=always).
- .ciagent/ @v1.4 references left as historical record (D-048 scope was static-asset rename only; @v1.4 is historical narrative of Phase 20).
- s3 OUTPUT_MAP bucket_regional_domain_name not added (identity fallback in adapt() already handles it; OUTPUT_MAP documents non-identity mappings only).
---ci---
56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
# Versioning
|
|
|
|
ACDL uses two versioning schemes: one for modules, one for the deploy
|
|
pipeline. Both matter to a consumer.
|
|
|
|
## Module versioning
|
|
|
|
Primitives and modules use **semver** with three triggers:
|
|
|
|
- **interface → MAJOR** — a breaking change to the module's inputs/outputs.
|
|
- **behavior → MINOR** — a backward-compatible behavior change.
|
|
- **lifecycle → PATCH** — a fix or internal change.
|
|
|
|
A MAJOR bump requires a **new registry entry** (immutable publication); the
|
|
old entry enters a **12-month deprecation window**. A module pins its
|
|
primitives by `name@semver`; the resolver picks the highest compatible.
|
|
|
|
Module versions are tracked in
|
|
[`registry.json`](https://github.com/acdl/acdl/blob/main/modules/registry.json).
|
|
|
|
## Deploy-pipeline versioning (the `uses:` tag)
|
|
|
|
The central deploy pipeline is referenced by a **floating MAJOR + MINOR
|
|
tag** in a consumer's contract and CI definition:
|
|
|
|
```yaml
|
|
uses: acdl/pipelines/deploy.yaml@v1.6
|
|
```
|
|
|
|
Version constraints cannot be expressed inside the contract, so the tag in
|
|
`uses:` is the only immutability lever a consumer has.
|
|
|
|
**Unversioned references are discouraged.** Do not use `@main` or a bare
|
|
`acdl/pipelines/deploy.yaml` — `main` is constantly updated and can cause
|
|
unexpected failures. Pinning to a MAJOR+MINOR tag means:
|
|
|
|
- **Immutability** — the pipeline behavior you tested is the behavior you
|
|
get. Patch fixes flow within the tag; breaking changes land under the
|
|
next MINOR tag (`@v1.5`), which you opt into explicitly.
|
|
- **Resilience** — your deployment does not break because an unrelated
|
|
change landed on `main`.
|
|
- **Reproducibility** — your setup is stable. You upgrade on your schedule
|
|
by bumping the tag.
|
|
|
|
## When a new tag is released
|
|
|
|
When a new MINOR tag is released (e.g. `@v1.5`), review its changelog and
|
|
bump your `uses:` reference when ready. The old tag continues to receive
|
|
patch fixes until the next MINOR tag.
|
|
|
|
## Production-bound references
|
|
|
|
For production-bound workflows, the platform resolves the current tag to its
|
|
SHA (tag for dev/qa, SHA for prod). This prevents a silent patch from
|
|
changing a production deployment. The platform provides a CLI command for
|
|
the tag → SHA resolution. |