@cakejp/design-system 0.5.0 → 0.7.0

package/RELEASE.md

@@ -1,205 +0,0 @@
-# Release Process
-
-@cakejp/design-system のリリース運用ルール。
-
----
-
-## 🗓 基本方針
-
-- **週 1 回・手動リリース** を原則とする
-- 自動 publish は無効化済み（タグ push しても何も起きない）
-- **金曜は publish しない**（万一トラブった時に対応できる人がいないため）
-- 緊急パッチは個別に手動実行
-
-### 標準スケジュール
-
-| 曜日 | 内容 |
-|---|---|
-| 月〜木 | 開発・PR レビュー・main マージ |
-| **金曜** | リリース確認・取りまとめ・version bump（コミットまで）<br>**publish はしない** |
-| 土・日 | お休み |
-| **月曜** | npm publish 実行 → 利用側で動作確認 |
-| 火〜木 | 問題があれば patch リリース対応 |
-
-### この運用にする理由
-
-- **Read-Only Friday**: 金曜は本番 publish しない（業界慣習）
-- 障害発生時に **対応できるエンジニアが翌営業日まで動ける** 状態でリリース
-- 利用側 (cake-api/frontend 等) も **週初めから安心して install** できる
-- 金曜時点で「意味ある単位にまとまっているか」を確認できれば、月曜の publish はスムーズ
-
----
-
-## 📦 リリース手順
-
-### 金曜 (確認のみ・publish はしない)
-
-1. main の差分を確認
-2. CHANGELOG.md を整理（minor/patch 判断）
-3. 必要なら version bump コミットだけ作る → main に push
-4. **ここで publish はせず、月曜の作業に残す**
-
-### 月曜 (publish 実行)
-
-1. main 最新を pull
-2. dry-run で事前確認
-3. 本番 publish
-4. cake-api/frontend で動作確認
-5. Slack で告知
-
----
-
-### 詳細手順
-
-### 1. リリース対象の取りまとめ
-
-```bash
-# main にマージ済みの差分を確認
-git log v$(npm view @cakejp/design-system version)..main --oneline
-```
-
-「意味ある単位」になっているか確認:
-- 機能追加・破壊的変更が複数ある → minor bump (`0.3.0` → `0.4.0`)
-- バグ修正のみ → patch bump (`0.3.0` → `0.3.1`)
-- 互換性ある内部改善のみ → patch bump
-
-### 2. version bump
-
-```bash
-# patch リリース
-npm version patch -m "chore(release): v%s"
-
-# minor リリース
-npm version minor -m "chore(release): v%s"
-
-# major リリース（注意）
-npm version major -m "chore(release): v%s"
-```
-
-`npm version` は package.json と package-lock.json を更新し、
-コミット作成までやってくれる。タグ作成は workflow 側でやるので
-`--no-git-tag-version` を付けたい場合は手動コミット。
-
-### 3. CHANGELOG.md / MIGRATION.md 更新
-
-破壊的変更・新機能・バグ修正の概要を CHANGELOG に追記。
-
-### 4. main に push
-
-```bash
-git push origin main
-```
-
-### 5. dry-run で事前検証
-
-```bash
-gh workflow run publish.yml -f dry_run=true
-```
-
-または GitHub UI で **Actions > Publish to npm > Run workflow** から実行。
-失敗ログを確認し、問題なければ次へ。
-
-### 6. 本番 publish
-
-```bash
-gh workflow run publish.yml -f dry_run=false -f tag_after_publish=true
-```
-
-または GitHub UI で実行。
-Workflow が npm publish + `v{version}` タグ作成を自動でやる。
-
-### 7. リリース後の確認
-
-```bash
-# npm に反映確認
-npm view @cakejp/design-system@$(node -p "require('./package.json').version")
-
-# 利用側で install 確認
-cd ../cake-api/frontend
-npm install @cakejp/design-system@latest
-```
-
----
-
-## 🚨 緊急パッチ
-
-平日でもセキュリティ脆弱性・本番障害対応のパッチは即時リリース可能:
-
-```bash
-# 1. fix ブランチ
-git checkout -b fix/critical-issue main
-# ... 修正
-
-# 2. PR → 緊急マージ
-gh pr create --base main --title "fix: critical security issue"
-gh pr merge --squash
-
-# 3. patch bump
-git checkout main && git pull
-npm version patch -m "chore(release): v%s (hotfix)"
-git push origin main
-
-# 4. publish
-gh workflow run publish.yml -f dry_run=false
-```
-
----
-
-## 🎯 ブランチ運用
-
-| 接頭辞 | 用途 | リリースに含める? |
-|---|---|---|
-| `feat/...` | 機能追加 | minor bump |
-| `fix/...` | バグ修正 | patch bump |
-| `refactor/...` | 内部整理 | minor or patch |
-| `docs/...` | ドキュメント | patch (またはスキップ) |
-| `chore/...` | 雑務（依存更新等） | リリース対象外（マージはする） |
-
----
-
-## 🔒 publish 権限
-
-publish 操作は **NPM_TOKEN を持つ GitHub Actions のみ** が実行可能。
-ローカルから `npm publish` を直接叩く運用は禁止。
-
-token 管理:
-- npmjs.com で Access Token を発行
-- リポジトリの Settings > Secrets and variables > Actions > `NPM_TOKEN`
-- token は **少なくとも 1 年に 1 度** rotate
-
----
-
-## 📋 リリース前チェックリスト
-
-```
-[ ] main 最新を pull
-[ ] 全 CI 通過確認
-[ ] npm run check で品質ゲート OK
-[ ] CHANGELOG.md 更新
-[ ] package.json version bump
-[ ] dry_run で事前検証
-[ ] publish 実行
-[ ] npm view で反映確認
-[ ] cake-api/frontend で動作確認
-[ ] Slack #design-system チャンネルに告知
-```
-
----
-
-## ⚠️ よくある失敗パターン
-
-| 失敗 | 原因 | 対策 |
-|---|---|---|
-| publish が走らない | NPM_TOKEN 未設定 / 期限切れ | secrets を再登録 |
-| `npm version` が main 以外で走る | 別ブランチで実行 | main で実行する |
-| dist が古い | build:lib スキップ | workflow が自動で実行するので問題なし |
-| 同じバージョンを 2 回 publish | npm が拒否 | バージョンを bump し直す（1 度発行された version は永久に上書き不可） |
-| `prepack` で本番ビルド失敗 | peer dep 不足 | npm ci で全部入る、ローカルで再現できないなら CI ログを確認 |
-
----
-
-## 🔗 関連ドキュメント
-
-- [CHANGELOG.md](./CHANGELOG.md) — 過去のリリース履歴
-- [MIGRATION.md](./MIGRATION.md) — バージョン間の移行ガイド
-- [.github/workflows/publish.yml](./.github/workflows/publish.yml) — publish workflow 定義