Skip to content

SDK versioning & release-alignment initiative (ADR-0019) — tracking #36780

Description

@KevinDavilaDotCMS

Description

Umbrella/tracking task for the multi-phase effort to align @dotcms/* SDK package versioning
and publishing with dotCMS's own date-lockstep release versioning
(ADR-0019),
and to give both dotCMS and SDK consumers a reliable way to detect and manage SDK-compatibility
breaks across releases.

Before this initiative, SDK packages versioned independently (SemVer, with a continuous @next
prerelease channel), had no way to signal a compatibility floor to installed clients, and had no
structured process for keeping that floor accurate over time. Each phase below closes one part of
that gap. This issue exists purely for tracking/visibility — sub-tickets are linked as they're
created, no new work is scoped directly on this issue itself.

Completed phases

Known follow-up, not yet ticketed

  • SDK/CLI npm publish currently fires on release: created, which happens very early in
    cicd_6-release.yml
    (inside release-prepare, as soon as the GitHub Release object is
    created) — well before build/deployment/release actually confirm the dotCMS release
    succeeded. Observed in practice: a real release run where the later phases failed, but the SDK
    packages had already published to npm. Proposed fix: create the GitHub Release as a draft in
    release-prepare (the git tag itself is unaffected by draft status, so build can still check
    it out), switch cicd_release-sdk.yml and cicd_release-cli.yml to trigger on
    release: published instead of release: created, and add a final step to cicd_6-release.yml
    (after build, deployment, release, and release-notes all succeed) that flips the release
    from draft to published — which is what would actually trigger the SDK/CLI publish. Affects both
    SDK and CLI publish, since both currently share the same created trigger. Needs its own ticket
    before work starts.

Priority

High

Additional Context

Each phase above was implemented, reviewed, and tested independently (including dry-runs in a
disposable fork, dotCMS/core-workflow-test, before touching this repo) — see each linked PR's
description and review-comment history for the detailed design decisions and edge cases considered
for that phase. This issue is a pure tracking/index task; sub-tickets get added here as they're
created.

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Status
    Current Sprint Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions