semantic-versioning について
semantic-versioningは、リリースに一貫したセマンティックバージョニングを適用するためのスキルです。パッケージ、ライブラリ、APIのバージョン管理に加え、バージョン更新や変更履歴の自動化、破壊的変更の追跡を扱います。
主な機能
- 01MAJOR.MINOR.PATCH形式の適用
- 02Conventional Commitsの利用
- 03バージョン更新の自動化
- 04変更履歴の生成
- 05破壊的変更の追跡
活用シーン
- 01パッケージやライブラリのリリース管理
- 02APIバージョンの管理
- 03バージョン更新とリリースノートの自動化
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ aj-geddes/ useful-ai-prompts --skill semantic-versioningインストール後、Claude Code で/semantic-versioningを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/changelog-generation.mdconventional-commits-format.mdsemantic-release-configuration.mdsemantic-versioning-configuration.mdversion-bumping-script.mdscripts/validate-api.shtemplates/api-scaffold.yaml詳細
セマンティックバージョニング
目次
概要
リリースの重要度に沿った一貫性のあるバージョン番号を維持するため、セマンティックバージョニングの運用方法を確立します。これにより、バージョン管理とリリースノートの生成を自動化できます。
使用する場面
- パッケージやライブラリのリリース
- 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/ ディレクトリを参照してください。
| ガイド | 内容 |
|---|---|
| セマンティックバージョニングの設定 | セマンティックバージョニングの設定 |
| Conventional Commits の形式 | Conventional Commits の形式 |
| Semantic Release の設定 | Semantic Release の設定 |
| バージョン更新スクリプト | バージョン更新スクリプト |
| 変更履歴の生成 | 変更履歴の生成 |
ベストプラクティス
✅ 推奨事項
- 厳密な MAJOR.MINOR.PATCH 形式に従います
- Conventional Commits を使用します
- バージョン更新を自動化します
- 変更履歴を自動生成します
- git でリリースにタグを付けます
- 破壊的変更を文書化します
- テストにはプレリリースバージョンを使用します
❌ 避けるべきこと
- 一貫性のない方法で手動でバージョンを更新する
- 破壊的変更の文書化を省略する
- 任意のバージョン番号を使用する
- パッチリリースに機能を混在させる
コメント
Markdown 対応