mcpField
C
changelog

changelog

github.com/motormetrics開発2246 回インストール3 日前に更新
リポジトリ

changelog について

release-please が Conventional Commits から CHANGELOG.md を生成・公開する手順を説明するリポジトリスキルです。メンテナー向けに、記載対象や Release PR の流れ、項目が欠けた場合の確認方法をまとめています。

主な機能

  1. 01コミット種別と変更履歴の区分を対応付け
  2. 02release-please の生成手順を解説
  3. 03リリースノート確認用コマンドを掲載
  4. 04項目不足の調査手順を記載

活用シーン

  1. 01コミットが変更履歴にない理由の確認
  2. 02保留中の Release PR のノートをプレビュー
  3. 03公開済み GitHub Release のノートを検索

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/motormetrics/motormetrics --skill changelog

インストール後、Claude Code で/changelogを入力して読み込まれたか確認します。

詳細

変更履歴スキル

CHANGELOG.md は、各リリース PR の一環として release-please によって生成されます。

仕組み

  1. release-please は main へのプッシュ時に実行されます
  2. 前回のリリース以降の Conventional Commits からリリースノートを生成します
  3. 開いているリリース PR の CHANGELOG.md の先頭にリリースノートを追加します
  4. リリース PR をマージすると変更履歴がコミットされ、同じリリースノートが GitHub リリースとして公開されます

変更履歴のセクション

コミットの種類は、次の変更履歴のセクションに対応します。

コミットの種類変更履歴のセクション
feat新機能
fixバグ修正
perfパフォーマンスの改善
revert取り消し
feat! / BREAKING CHANGE⚠ 破壊的変更

chore、docs、refactor、test、ci、build、style の種類は、変更履歴に表示されません。

変更履歴の表示

# View the changelog file
cat CHANGELOG.md

# View a specific GitHub release's notes
gh release view v5.31.0

# Preview the next entry in the open Release PR
gh pr list --label "autorelease: pending"

変更履歴の項目がありませんか？

  1. コミットの種類を確認します。項目が生成されるのは feat、fix、perf、revert のみです
  2. コミットが main に取り込まれていることを確認します
  3. リリース PR が更新されていることを確認します：gh run list --workflow=release.yml
  4. コミットメッセージが Conventional Commits 形式に従っていることを確認します

ファイルの場所

  • 変更履歴：CHANGELOG.md（リポジトリのルート）
  • 設定：release-please-config.json

関連項目

  • リリースのワークフローについては release-management スキルを参照してください

コメント

Markdown 対応