Sparkle Design

バージョニングポリシー

バージョニングポリシー カバー

Sparkle DesignのバージョニングはSemantic Versioning 2.0.0の原則に準じます。

セマンティックバージョニングの概要

バージョン番号はx.y.zのように表記します。

名称 (英)意味
xMAJOR後方互換性を破壊する変更1.12.4→2.0.0
yMINOR後方互換性を維持した機能追加2.3.6→2.4.0
zPATCHバグ修正や小規模な改善2.4.0→2.4.1

3つの数字を左から順に判定し、上位の変更ほど影響範囲が大きいことを示します。

セマンティック バージョニング 2.0.0Semantic Versioning spec and websitesemver.org

バージョン番号の構成

System Version

MAJOR.MINOR.PATCH
例: 2.4.1

Sparkle Design全体のバージョンです。チームが公式にサポートするAPIの挙動や整合性、全体最適を保証する境界を示すことが狙いです。

Artifact Version

MAJOR.MINOR.SYSTEMPATCH-ARTIFACTPATCH
例: figma-lib@2.4.0-3

Figmaファイル, Figmaプラグイン, npmパッケージなどの個別要素のバージョンです。SystemVersion‑patch方式を採用しています。

Artifact内でのみ破壊的な変更を行う場合もSystem Versionを上げる対応を行います。

成果物ごとの独立したアップデートを許容しつつ、System Versionとの互換を即座に読み取れるようにすることが狙いです。

Sparkle Design における具体例

MAJORバージョンを上げる場合

  • コンポーネントのAPI (プロパティ) 修正
    • コンポーネントの特定のプロパティを廃止
    • コンポーネントの特定のプロパティの命名を変更

プラグインの後方互換性が破壊される修正や既に使用している箇所でビルドエラーが発生する変更も該当します

MINORバージョンを上げる場合

  • 新規コンポーネントを追加
  • コンポーネントに新規プロパティを追加

PATCHバージョンを上げる場合

  • バグ修正
  • ドキュメントの誤字修正

参考文献

セマンティック バージョニング 2.0.0Semantic Versioning spec and websitesemver.org
小さな気づきや違和感があればお気軽に教えてください。
フィードバック
Chat illustration