@cakejp/design-system 0.3.2 → 0.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/PUBLISHING.md +106 -0
- package/README.md +20 -1
- package/dist/index.js +1 -1
- package/package.json +2 -1
package/PUBLISHING.md
ADDED
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# 公開とタグ付け(人向けクイックガイド)
|
|
2
|
+
|
|
3
|
+
@cakejp/design-system を npm に公開する方法と、Git タグの仕組みについて。
|
|
4
|
+
|
|
5
|
+
詳しい運用ルール(曜日・週次フロー等)は [`RELEASE.md`](./RELEASE.md) を参照。
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 結論 — やること
|
|
10
|
+
|
|
11
|
+
1. **main に変更をマージ**(PR 経由)
|
|
12
|
+
2. **`package.json` の `version` を上げる**(例: `0.3.3` → `0.3.4`)
|
|
13
|
+
3. **`gh workflow run publish.yml -f dry_run=false`** を実行
|
|
14
|
+
→ 自動で npm publish + Git タグ作成(`v0.3.4`)まで一気にやる
|
|
15
|
+
|
|
16
|
+
タグは **手動で打たない**。Action が自動で作る。
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## アクション(GitHub Actions)の実行方法
|
|
21
|
+
|
|
22
|
+
### A. GitHub の Web UI からポチる
|
|
23
|
+
|
|
24
|
+
1. https://github.com/flashpark/cake-design-system にアクセス
|
|
25
|
+
2. 上の「**Actions**」タブをクリック
|
|
26
|
+
3. 左サイドバーの「**Publish to npm**」を選択
|
|
27
|
+
4. 右上の「**Run workflow**」ボタン
|
|
28
|
+
5. ダイアログで `Branch: main` のまま、`Dry run` のチェックは外す
|
|
29
|
+
6. 緑の「**Run workflow**」を押す
|
|
30
|
+
|
|
31
|
+
### B. ターミナルから一発
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# 念のため事前確認(npm publish --dry-run のみ実行、本番に影響なし)
|
|
35
|
+
gh workflow run publish.yml -f dry_run=true
|
|
36
|
+
|
|
37
|
+
# 本番 publish + タグ作成
|
|
38
|
+
gh workflow run publish.yml -f dry_run=false
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## タグ付けはどうなってる?
|
|
44
|
+
|
|
45
|
+
### 自動
|
|
46
|
+
|
|
47
|
+
`gh workflow run publish.yml` 実行時に **デフォルトで Git タグ `v{version}` が自動作成・push** される。
|
|
48
|
+
|
|
49
|
+
- `package.json` の `version: 0.3.4` で実行 → `v0.3.4` タグが main にぶら下がる
|
|
50
|
+
- 既にタグ存在する場合は skip(重複エラーにならない)
|
|
51
|
+
|
|
52
|
+
### 手動で打ちたいケース
|
|
53
|
+
|
|
54
|
+
通常は不要。やるなら:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
git tag v0.3.4
|
|
58
|
+
git push origin v0.3.4
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### タグを作らずに publish したい
|
|
62
|
+
|
|
63
|
+
`tag_after_publish: false` を指定:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
gh workflow run publish.yml -f dry_run=false -f tag_after_publish=false
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## 何が公開されたか確認
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
# npm に反映されたか
|
|
75
|
+
npm view @cakejp/design-system version
|
|
76
|
+
# → 例: 0.3.4
|
|
77
|
+
|
|
78
|
+
# 全 version 一覧
|
|
79
|
+
npm view @cakejp/design-system versions
|
|
80
|
+
|
|
81
|
+
# タグ一覧
|
|
82
|
+
git fetch --tags origin
|
|
83
|
+
git tag --list | sort -V
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
公開直後は npm のキャッシュ反映に **30〜90 秒**かかる。
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## トラブルシュート
|
|
91
|
+
|
|
92
|
+
| 症状 | 確認 |
|
|
93
|
+
|------|------|
|
|
94
|
+
| Action 実行できない | Settings > Actions > Workflow permissions が `Read and write` か |
|
|
95
|
+
| publish が失敗する | NPM_TOKEN が有効期限切れの可能性 |
|
|
96
|
+
| タグが作られない | Workflow ログで「Create release tag」step を確認 |
|
|
97
|
+
| 「金曜にやるな」と怒られる | [`RELEASE.md`](./RELEASE.md) の Read-Only Friday ルール参照 |
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## 関連ドキュメント
|
|
102
|
+
|
|
103
|
+
- [`RELEASE.md`](./RELEASE.md) — 詳細運用ルール(曜日・チェックリスト・緊急 hotfix 等)
|
|
104
|
+
- [`CHANGELOG.md`](./CHANGELOG.md) — 各バージョンの変更履歴
|
|
105
|
+
- [`MIGRATION.md`](./MIGRATION.md) — メジャーバージョンの移行手順
|
|
106
|
+
- [`.github/workflows/publish.yml`](./.github/workflows/publish.yml) — Workflow 定義
|
package/README.md
CHANGED
|
@@ -36,9 +36,28 @@ import "@cakejp/design-system/dist/index.css"
|
|
|
36
36
|
- [Storybook](https://flashpark.github.io/cake-design-system/) — 全コンポーネントのカタログ
|
|
37
37
|
- [CHANGELOG.md](./CHANGELOG.md) — リリース履歴
|
|
38
38
|
- [MIGRATION.md](./MIGRATION.md) — バージョン間移行ガイド
|
|
39
|
-
- [
|
|
39
|
+
- [PUBLISHING.md](./PUBLISHING.md) — 公開とタグ付けのクイックガイド(人向け)
|
|
40
|
+
- [RELEASE.md](./RELEASE.md) — リリース運用ルール(週1手動・詳細)
|
|
40
41
|
- [CLAUDE.md](./CLAUDE.md) — AI エージェント向け使用ルール
|
|
41
42
|
|
|
43
|
+
## 公開とタグ付け(メンテナ向け)
|
|
44
|
+
|
|
45
|
+
このパッケージの新バージョンを npm に公開する方法:
|
|
46
|
+
|
|
47
|
+
1. **main に変更をマージ**(PR 経由)
|
|
48
|
+
2. **`package.json` の `version` を上げる**(例: `0.3.3` → `0.3.4`)
|
|
49
|
+
3. **GitHub Actions を実行**:
|
|
50
|
+
- Web UI: Actions タブ > 「Publish to npm」 > 「Run workflow」
|
|
51
|
+
- またはターミナル: `gh workflow run publish.yml -f dry_run=false`
|
|
52
|
+
4. Workflow が以下を自動でやる:
|
|
53
|
+
- `npm publish`
|
|
54
|
+
- **Git タグ `v{version}` の作成と push**
|
|
55
|
+
|
|
56
|
+
**タグは手動で打たない**(Action が自動で作成)。
|
|
57
|
+
手動で `git tag` を作る必要はありません。
|
|
58
|
+
|
|
59
|
+
詳細は [PUBLISHING.md](./PUBLISHING.md) と [RELEASE.md](./RELEASE.md) を参照。
|
|
60
|
+
|
|
42
61
|
## バージョン移行
|
|
43
62
|
|
|
44
63
|
### v0.2.x → v0.3.0
|
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cakejp/design-system",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.4",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Cake.jp Design System — UI コンポーネント・カラートークン・タイポグラフィ",
|
|
6
6
|
"license": "UNLICENSED",
|
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
"CLAUDE.md",
|
|
37
37
|
"CLAUDE_PRODUCTION.md",
|
|
38
38
|
"MIGRATION.md",
|
|
39
|
+
"PUBLISHING.md",
|
|
39
40
|
"RELEASE.md",
|
|
40
41
|
"bin",
|
|
41
42
|
"component-registry.json",
|