mcpField
G
github-release-best-practices

github-release-best-practices

github.com/d-o-hub開発1337 回インストール今日更新
リポジトリ

github-release-best-practices について

github-release-best-practices は、このリポジトリの GitHub リリース手順に従うメンテナー向けの参考資料です。リリース前のバージョンと変更履歴の更新、指定コマンド、リリースノートの確認方法を説明します。

主な機能

  1. 01`Cargo.toml` のバージョン更新を説明
  2. 02変更履歴のバージョン見出し形式を指定
  3. 03リリース前のロードマップと状況更新を提示
  4. 04リリースコマンドとノート確認方法を記載
  5. 05Semver の更新幅と変更分類を説明

活用シーン

  1. 01マージ前にリリース変更を準備
  2. 02指定スクリプトでリリースを実行
  3. 03GitHub Release のノート内容を確認
  4. 04修正や機能追加のバージョン更新幅を判断

インストール

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

$npx skills add https://github.com/d-o-hub/rust-self-learning-memory --skill github-release-best-practices

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

同梱ファイルevals/evals.json

詳細

GitHub リリースのベストプラクティス（参考のみ）

正式な手順： release-guard
正式な CLI： ./scripts/release-manager.sh ship --execute
GitHub リリースの作成元： .github/workflows/release.yml（タグのプッシュのみ）

2 つ目のリリース手順を作らないでください。このファイルは補足情報のみです。

ship の前の準備（main への PR 経由）

  1. ルートの Cargo.toml でワークスペースの version を更新します（すべてのメンバーがワークスペースに従います）。
  2. CHANGELOG.md を更新し、## [X.Y.Z] - YYYY-MM-DD を正確に 1 つ記載します（一意でないバージョン見出しがあると、cargo-dist/parse-changelog はエラーを通知せずに失敗し、GitHub リリースの本文が空になります）。
  3. plans/ROADMAPS/ROADMAP_ACTIVE.md と plans/STATUS/CURRENT.md の Released Version を vX.Y.Z に設定します。
  4. PR をマージし、main の CI が成功するまで待ちます。
  5. 次を実行します：./scripts/release-manager.sh ship --execute
  6. リリースノートを確認します：gh release view vX.Y.Z に ## Release Notes の内容が表示されることを確認します（v0.1.34/v0.1.35 形式）。

Semver（0.x）

変更バージョンアップ
破壊的変更minor または major（チームで決定）
機能minor を推奨
修正patch

変更履歴のカテゴリ

追加 · 変更 · 非推奨 · 削除 · 修正 · セキュリティ

禁止事項

# DO NOT — bypasses cargo-dist and release.yml preflight
gh release create vX.Y.Z ...

参考資料

  • ADR-034 リリースエンジニアリング
  • .agents/skills/release-guard/SKILL.md
  • ./scripts/release-manager.sh

コメント

Markdown 対応