CHANGELOG + SemVer commitment + base image publishing strategy #9

Open
opened 2026-05-04 15:42:19 +02:00 by libretech · 0 comments
Owner

Part of #2

Goal

Establish libreshop/shop as a publicly versioned base image with documented override surface and SemVer guarantees, so adapters (mp and future) can pin and migrate safely.

Acceptance

  • CHANGELOG.md in libreshop/shop with semver convention:
    • Major = breaking override surface (component renamed/removed, slot signature changed, frontmatter/composable shape changed, env-var rename)
    • Minor = additive (new components, new optional config)
    • Patch = bugfix
  • Each major release ships a migrations/vX-to-vY.md with concrete adapter migration steps (codemod scripts where feasible)
  • CI publishes git.librete.ch/libreshop/shop:vX.Y.Z + :vX + :latest on tag push (already configured for :vX.Y.Z; add semver moving tags)
  • Bare image is functional and deployable — running docker run libreshop/shop:vX.Y.Z produces a working demo shop with placeholder branding
  • README documents the public override surface (links to ls#4 outcome)
  • No further changes to internal components without major bump if they are part of the surface
Part of https://git.librete.ch/libreshop/shop/issues/2 ## Goal Establish libreshop/shop as a publicly versioned base image with documented override surface and SemVer guarantees, so adapters (mp and future) can pin and migrate safely. ## Acceptance - [ ] `CHANGELOG.md` in libreshop/shop with semver convention: - **Major** = breaking override surface (component renamed/removed, slot signature changed, frontmatter/composable shape changed, env-var rename) - **Minor** = additive (new components, new optional config) - **Patch** = bugfix - [ ] Each major release ships a `migrations/vX-to-vY.md` with concrete adapter migration steps (codemod scripts where feasible) - [ ] CI publishes `git.librete.ch/libreshop/shop:vX.Y.Z` + `:vX` + `:latest` on tag push (already configured for `:vX.Y.Z`; add semver moving tags) - [ ] Bare image is **functional and deployable** — running `docker run libreshop/shop:vX.Y.Z` produces a working demo shop with placeholder branding - [ ] README documents the public override surface (links to ls#4 outcome) - [ ] No further changes to internal components without major bump if they are part of the surface
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: libreshop/shop#9
No description provided.