Skip to content

Finalize Margo Version Management Strategy #174

@ajcraig

Description

@ajcraig

GOAL:

Create a concrete version management strategy across the various deliverables Margo maintains. This will be critical as we iterate moving towards our first GA release.

Proposed Strategy:

Utilize symantec versioning outlined in the following Markdown:
- https://docs.margo.org/margo-specification-versioning#specification-maturity-stages

  • Determining factor is the scale of changes changes and whether breaking / med / small changes/fixes

Specification

  • Current state: no version right now: “Pre-Draft” stage
    • See initial link above for more details.
  • Decoupled from sandbox deliverable/versions other than:
    • Workload Management API linkage between sandbox
      • API is version 1.0.0(currently)
      • [PROPOSAL] revert the version back to 0.0.1-rc1

Sandbox

Additional collateral around proposed version management within the Sandbox repository.
- SEE HERE

  • Whole sandbox deliverable to get a version upon the next release.
    • versioning not so important as specification or other official deliverables
    • Change log of this deliverable is crucial to inform users of updates, and whether it's worth their time to tear down and redeploy the whole sandbox, just pieces, or ignore the release.
  • Version is separate from Ref Implementation + Specification
    • **[PROPOSAL]**Version 1.0.0 (version managed separate from openAPI spec)
      • Post plugfest
      • Implementation of fixes
      • Tied to API version 0.0.1-rc1

FUTURE (GA Release will cement versioning of these items)

Conformance test

  • To be versioned with specification

Reference implementation

  • To be versioned with specification

Additional Tasks:

  • Need to create a notification channel for releases Sandbox

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Gen. Improvements: Non SUP

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions