mcpField
D
docs-changelog

docs-changelog

github.com/google-geminiドキュメント108.6k1.3k 回インストール今日更新
リポジトリ

docs-changelog について

バージョン、タイムスタンプ、Markdown のリリースノートを基に変更履歴ファイルを更新する手順スキルです。安定版とプレビュー版、マイナー版とパッチ版を区別し、更新方法を示します。

主な機能

  1. 01安定版とプレビュー版の分岐
  2. 02マイナー版とパッチ版の手順
  3. 03リリースノートの前処理
  4. 04変更履歴テンプレートの更新
  5. 05フォーマット確認と後片付け

活用シーン

  1. 01マイナーリリースの変更履歴更新
  2. 02パッチリリースのノート追加
  3. 03プレビュー版ドキュメントの準備

インストール

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

$npx skills add https://github.com/google-gemini/gemini-cli --skill docs-changelog

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
highlights_examples.md
index_template.md
latest_template.md
preview_template.md

詳細

手順:新しいリリースの変更履歴を更新する

目的

自動リリース情報に基づいて、変更履歴ファイル(latest.md、 preview.md、index.md)を更新するプロセスを標準化します。

入力

  • version:リリースのバージョン文字列(例:v0.28.0、 v0.29.0-preview.2)。
  • TIME:リリースのタイムスタンプ(例:2026-02-12T20:33:15Z)。
  • BODY:「What's Changed」セクションと「Full Changelog」リンクを含む、マークダウン形式の未加工のリリースノート。

latest.md および preview.md のハイライトに関するガイドライン

  • 3~5 個の重要なハイライトを目指します。
  • 各ハイライトは、変更内容を要約する太字のタイトルで始めます(例:**新機能:** 簡単な説明...)。
  • バグ修正や雑務などのほかの変更よりも、新機能の要約を優先します。
  • Stable Release では、「experimental」または「in preview」の機能に言及することを避けてください。
  • これらのハイライトには、PR 番号、リンク、作者名を含めないでください。
  • 適切なスタイルとトーンについては、.gemini/skills/docs-changelog/references/highlights_examples.md を参照してください。

初期処理

  1. バージョンを分析する:version 文字列に基づいてリリースパスを決定します。
    • version に「nightly」が含まれる場合は、停止します。変更は行いません。
    • version が .0 で終わる場合は、パス A:新しいマイナーバージョンの手順に従います。
    • version が .0 で終わらない場合は、パス B:パッチバージョンの手順に従います。
  2. 時刻を処理する:後で使用するため、入力された TIME を yyyy-mm-dd と Month dd, yyyy の 2 つの形式に変換します。
  3. 本文を処理する:
    • 受け取った BODY の内容を、一時ファイルに保存して処理します。
    • 一時ファイルの「What's Changed」セクションで、すべてのプルリクエスト URL を、PR 番号をテキストとするマークダウンリンクに整形します(例:[#12345](URL))。
    • 「New Contributors」セクションがある場合は削除します。
    • 「Full Changelog」リンクは保持します。この一時ファイルの処理済みの内容を、後続の手順で使用します。

パス A:新しいマイナーバージョン

バージョン番号が .0 で終わる場合に、このパスを使用します。

重要: バージョンに基づいて、安定版リリース向けのセクション A.1、またはプレビューリリース向けのセクション A.2 のいずれかを選択して従ってください。もう一方のセクションの手順には従わないでください。

A.1:安定版リリース(例:v0.28.0)

安定版リリースでは、変更履歴から 2 種類の要約を作成します。メインの変更履歴ページ向けの簡潔な告知と、リリース固有ページ向けのより詳しいハイライトです。

  1. index.md の告知を作成する:

    • 最も重要な変更を要約した簡潔な告知を作成します。告知の各項目は、変更内容を要約する太字のタイトルで始めます。
    • 重要: この告知の形式は独自のものです。ガイドとして、docs/changelogs/index.md の既存の告知と .gemini/skills/docs-changelog/references/index_template.md 内の例を必ず使用してください。この形式には PR リンクと作者名が含まれます。PR リンクと作者名は 1~2 件にしてください。
    • この新しい告知を docs/changelogs/index.md の先頭に追加します。
  2. ハイライトを作成し、latest.md を更新する:

    • 上記の「latest.md および preview.md のハイライトに関するガイドライン」に従って、包括的な「Highlights」セクションを作成します。
    • .gemini/skills/docs-changelog/references/latest_template.md の内容を使用します。
    • version、release_date、作成した highlights、および一時ファイルの処理済みの内容をテンプレートに入力します。
    • 入力済みのテンプレートで docs/changelogs/latest.md の内容を完全に置き換えます。
A.2:プレビューリリース(例:v0.29.0-preview.0)
  1. preview.md を更新する:
    • ハイライトのガイドラインに従って、包括的な「Highlights」セクションを作成します。
    • .gemini/skills/docs-changelog/references/preview_template.md の内容を使用します。
    • テンプレートに version、release_date、作成した highlights、および一時ファイルから処理した内容を記入します。
    • 記入済みのテンプレートで docs/changelogs/preview.md の内容を完全に置き換えます。

パス B:パッチバージョン

バージョン番号が .0 で終わらない場合は、このパスを使用します。

重要: バージョンに基づいて、安定版パッチ向けのセクション B.1 またはプレビューパッチ向けのセクション B.2 のいずれかに従う必要があります。もう一方のセクションの指示には従わないでください。

B.1:安定版パッチ(例:v0.28.1)
  • 対象ファイル:docs/changelogs/latest.md
  • 対象ファイルに次の編集を行います:
    1. メインヘッダーのバージョンを更新します。行は次のようになります。 # Latest stable release: {{version}}

    2. リリース日を更新します。行は次のようになります。 Released: {{release_date_month_dd_yyyy}}

    3. 一時ファイルに「What's Changed」セクションがあるか確認します。 ある場合は手順 4 に進みます。ない場合は手順 5 に進みます。

    4. 一時ファイルから処理した「What's Changed」リストを、latest.md の既存の「What's Changed」リストの先頭に追加します。既存のリストは変更または置換せず、先頭に追加するだけにしてください。

    5. 「Full Changelog」では、URL の末尾だけを編集します。...{previous_version} のような URL の最後の部分を特定し、...{version} に更新します。

      例:パッチバージョンが v0.29.1 だとします。次のように変更します。 Full Changelog: https://github.com/google-gemini/gemini-cli/compare/v0.28.2…v0.29.0 を Full Changelog: https://github.com/google-gemini/gemini-cli/compare/v0.28.2…v0.29.1 に変更します。

B.2:プレビューパッチ(例:v0.29.0-preview.3)
  • 対象ファイル:docs/changelogs/preview.md
  • 対象ファイルに次の編集を行います:
    1. メインヘッダーのバージョンを更新します。行は次のようになります。 # Preview release: {{version}}

    2. リリース日を更新します。行は次のようになります。 Released: {{release_date_month_dd_yyyy}}

    3. 一時ファイルに「What's Changed」セクションがあるか確認します。 ある場合は手順 4 に進みます。ない場合は手順 5 に進みます。

    4. 一時ファイルから処理した「What's Changed」リストを、preview.md の既存の「What's Changed」リストの先頭に追加します。既存のリストは変更または置換せず、先頭に追加するだけにしてください。

    5. 「Full Changelog」では、URL の末尾だけを編集します。...{previous_version} のような URL の最後の部分を特定し、...{version} に更新します。

      例:パッチバージョンが v0.29.0-preview.1 だとします。次のように変更します。 Full Changelog: https://github.com/google-gemini/gemini-cli/compare/v0.28.2…v0.29.0-preview.0 を Full Changelog: https://github.com/google-gemini/gemini-cli/compare/v0.28.2…v0.29.0-preview.1 に変更します。


最終処理

  • 変更を加えた後、npm run format が失敗する場合は、フォーマット関連の依存関係をすべて利用できるようにするため、先に npm install を実行する必要がある場合があります。その後、一貫性を保つために npm run format を実行します。
  • 作業中に作成した一時ファイルを削除します。

コメント