Skip to content
cccskills
FreePublished on GitHub

generate-docs

git logからCHANGELOGとリリースノートを自動生成する。リリース作業時に使用。

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md4.0 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Document Generation - ドキュメント自動生成

git logから CHANGELOG とリリースノートを自動生成する。リリース時に手動呼び出しして使用する。

実行フロー

Step 1: バージョン情報の確認
  ↓
Step 2: git log の解析
  ↓
Step 3: CHANGELOG.md の更新
  ↓
Step 4: リリースノート生成
  ↓
Step 5: ユーザー確認

Step 1: バージョン情報の確認

前回リリースタグの取得

# タグ命名規則: vX.Y.Z
git describe --tags --abbrev=0

タグがない場合(初回リリース)は全コミットを対象とする。

次のバージョンの決定

ユーザーに確認する。デフォルト提案としてコミットタイプから推定:

コミット内容バージョンアップ例
feat: が含まれるマイナーv1.0.0 -> v1.1.0
fix: のみパッチv1.0.0 -> v1.0.1
breaking change(! suffix)メジャーv1.0.0 -> v2.0.0

Step 2: git log の解析

# 前回タグからのコミット取得
PREV_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
if [ -z "$PREV_TAG" ]; then
  git log --oneline --no-merges
else
  git log ${PREV_TAG}..HEAD --oneline --no-merges
fi

コミットメッセージの type でカテゴリ分類する(Conventional Commits形式を前提とする。コミットメッセージ規約は documents/development/coding-rules/common-rules.md Section 1 を参照):

TypeカテゴリCHANGELOG セクション
feat:新機能Added
fix:バグ修正Fixed
refactor: / perf:変更Changed
docs:ドキュメントDocumentation
test: / chore: / style:その他Other (CHANGELOGには含めない)

Step 3: CHANGELOG.md の更新

Keep a Changelog 形式に準拠する。

CHANGELOG.md がなければ新規作成、あれば先頭に追記する。

フォーマット

# Changelog

## [X.Y.Z] - YYYY-MM-DD

### Added
- feat: コミットからの機能追加一覧

### Fixed
- fix: コミットからのバグ修正一覧

### Changed
- refactor/perf: コミットからの変更一覧

### Documentation
- docs: コミットからのドキュメント変更一覧

ルール:

  • 空のセクションは含めない(例: fix コミットがなければ Fixed セクションは省略)
  • コミットメッセージの type プレフィックスは除去してエントリに記載
  • Issue番号やPR番号がある場合はリンクとして含める

Step 4: リリースノート生成

GitHub Releases に投稿可能な形式で生成する。

フォーマット

## What's Changed

### New Features
- 機能1の説明 (#PR番号)
- 機能2の説明 (#PR番号)

### Bug Fixes
- 修正1の説明 (#PR番号)

### Other Changes
- その他の変更

**Full Changelog**: https://github.com/[owner]/[repo]/compare/[前回タグ]...[新タグ]

ルール:

  • コミットメッセージをそのまま使わず、ユーザー向けに読みやすく書き直す
  • 技術的な詳細(リファクタリング、テスト追加等)はリリースノートから除外
  • 空のセクションは含めない

Step 5: ユーザー確認

以下を出力してユーザーに確認する:

  1. CHANGELOG.md の差分を表示 - 追記された内容を確認
  2. リリースノートをコンソールに出力 - GitHub Releases に投稿する内容を確認
  3. 次のアクション提案:
    • git tag vX.Y.Z でタグ作成
    • gh release create vX.Y.Z --notes-file <file> でGitHub Release作成
    • または手動でGitHub Releases に投稿

ユーザーの承認後にのみ、CHANGELOG.md をコミットする。

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

バックエンド実装時に使用。DRY原則遵守。コーディング規約準拠。

The English summary is being prepared. Showing the original description.

Crearize/ai-dev-helm5Updated Oct 12, 2026

Use before implementing any feature, behavior change, or refactor - settles requirements and design, then gets the design independently reviewed and approved by the user before code is written

The English summary is being prepared. Showing the original description.

Crearize/ai-dev-helm5Updated Oct 12, 2026

作業開始時に使用。mainブランチでの作業禁止。Issue先行作成必須。

The English summary is being prepared. Showing the original description.

Crearize/ai-dev-helm5Updated Oct 12, 2026

UI実装後の検証時に使用。agent-browser CLIでブラウザ上の動作を手動検証する。「UIを確認」「画面テスト」と言われたら使用(プロジェクトの E2E スイート実行は quality-check Step 5(推奨度・範囲で自動実施または確認)/ server-startup が担当)。

The English summary is being prepared. Showing the original description.

Crearize/ai-dev-helm5Updated Oct 12, 2026

DBマイグレーション作成時に使用。バージョン番号競合防止。mainブランチ確認必須。

The English summary is being prepared. Showing the original description.

Crearize/ai-dev-helm5Updated Oct 12, 2026

Use when independent tasks benefit from parallel work without shared state or sequential dependencies

The English summary is being prepared. Showing the original description.

Crearize/ai-dev-helm5Updated Oct 12, 2026

See all skills by Crearize

Report a problem with this skill