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

目次

• 概要
• 使用場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

セマンティック バージョニングの慣例を確立することで、リリースの重要度に合わせた一貫したバージョン番号付けを維持し、自動化されたバージョン管理とリリースノートの生成を実現します。

使用場面

• パッケージとライブラリのリリース
• API バージョニング
• バージョン更新の自動化
• リリースノートの生成
• 破壊的変更の追跡
• 依存関係の管理
• 変更履歴の管理

クイックスタート

最小限の動作例:

# package.json
{
  "name": "my-awesome-package",
  "version": "1.2.3",
  "description": "An awesome package",
  "main": "dist/index.js",
  "repository": { "type": "git", "url": "https://github.com/org/repo.git" },
  "scripts": { "release": "semantic-release" },
  "devDependencies":
    {
      "semantic-release": "^21.0.0",
      "@semantic-release/changelog": "^6.0.0",
      "@semantic-release/git": "^10.0.0",
      "@semantic-release/github": "^9.0.0",
      "conventional-changelog-cli": "^3.0.0",
    },
}

リファレンスガイド

references/ ディレクトリ内の詳細な実装:

ガイド	内容
Semantic Versioning Configuration	Semantic Versioning 設定
Conventional Commits Format	Conventional Commits フォーマット
Semantic Release Configuration	Semantic Release 設定
Version Bumping Script	バージョン更新スクリプト
Changelog Generation	変更履歴の生成

ベストプラクティス

✅ すべきこと

• 厳密な MAJOR.MINOR.PATCH フォーマットに従う
• Conventional Commits を使用する
• バージョン更新を自動化する
• 変更履歴を自動的に生成する
• Git でリリースをタグ付けする
• 破壊的変更を文書化する
• テスト用にプレリリース バージョンを使用する

❌ してはいけないこと

• バージョンを手動で矛盾なく更新する
• 破壊的変更の文書化をスキップする
• 任意のバージョン番号付けを使用する
• パッチリリースに機能を混在させる