Skip to content

Commit 1c8a44f

Browse files
authored
ブランチ運用とリリース作業についてのドキュメントを追加 (#962)
* Create branches-and-releasing.md * fix
1 parent 8371a7a commit 1c8a44f

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

docs/branches-and-releasing.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
このドキュメントは、記載時点でのブランチの運用方法を記録したaiscript-dev member向けの参考資料です。
2+
現在の実態とは乖離した内容が記載されている可能性があります。
3+
4+
## ブランチの運用
5+
### masterブランチ
6+
デフォルトブランチであり、マイナーリリース用ブランチです。非破壊的変更のプルリクエストはここ向けに作成してください。
7+
[publish-nightly](/.github/workflows/publish-nightly.yml)ワークフローにより、変更があると開発中バージョン(`dev-<DATE>`)がpublishされます。
8+
### aiscript-nextブランチ
9+
メジャーリリース用ブランチで、破壊的変更のプルリクエストはここ向けに作成してください。
10+
定期的にmasterブランチをマージします。(このときはsquashマージは使用しないでください)
11+
[publish-nightly](/.github/workflows/publish-nightly.yml)ワークフローにより、変更があると開発中バージョン(`next-<DATE>`)がpublishされます。
12+
メジャーリリースが近いときはmasterに合流されていることもあります。その場合は破壊的変更・非破壊的変更共にmasterにpushします。
13+
### gh-pagesブランチ
14+
[簡易playground](https://aiscript-dev.github.io/aiscript/)のデプロイ用です。
15+
### bugfix用ブランチ
16+
特にブランチ名は決まっていません。bugfix用に作成され、リリースされると削除されます。
17+
作成時は前回リリース時のコミットから分岐してください。
18+
### その他のブランチ
19+
特に用途は決まっていません。aiscript-devのmemberが自由に作成・使用することができます。
20+
dependabotのPRや古いプロジェクトのアーカイブなどがあります。
21+
22+
## 新バージョンをリリースするときの流れ
23+
### bugfixリリース
24+
バグ修正。できるだけ早急にリリースを目指す。バージョンx.y.zのzを一つ上げる。
25+
- bugfix用のブランチを作成。前回リリース時のコミットから分岐する。
26+
- master(マイナーリリース用ブランチ)ではないので注意。
27+
- bugfixブランチに修正用PRをマージ/コミットをプッシュ。
28+
- bugfixブランチで`npm version patch && npm run pre-release`を実行し、結果をプッシュ。
29+
- bugfixブランチで`npm publish`
30+
- bugfixブランチで`git tag <バージョン名> && git push --tag`
31+
- bugfixブランチをmasterブランチに合流。
32+
- package.jsonなどのバージョンにコンフリクトが生じた場合、masterのものを反映。
33+
### マイナーリリース
34+
非破壊的変更。バージョンx.y.zのyを一つ上げ、zを0にする。
35+
- 事前にdependabotの更新があれば極力マージする。
36+
- masterブランチで`npm run pre-release`を実行し、結果をプッシュ。
37+
- masterブランチで`npm publish`
38+
- masterブランチで`git tag <バージョン名> && git push --tag`
39+
- masterブランチで`npm version minor && npm run build && npm run api`を実行、結果をプッシュ。
40+
### メジャーリリース
41+
破壊的変更。バージョンx.y.zのxを一つ上げ、yとzを0にする。
42+
- aiscript-nextブランチをmasterブランチに合流。
43+
- package.jsonなどのバージョンにコンフリクトが生じた場合、aiscript-nextのものを反映。
44+
- この合流は、次回リリースがメジャーリリースになると決まった段階でいつでもおこなってよい。
45+
- dependabotの更新があれば極力マージする。
46+
- masterブランチで`npm run pre-release`を実行し、結果をプッシュ。
47+
- masterブランチで`npm publish`
48+
- masterブランチで`git tag <バージョン名> && git push --tag`
49+
- masterブランチからaiscript-nextブランチを再作成。
50+
- aiscript-nextブランチで`npm version major && npm run build && npm run api`を実行、結果をプッシュ。
51+
- masterブランチで`npm version minor && npm run build && npm run api`を実行、結果をプッシュ。
52+
### 補遺
53+
#### publish後にnpm version minor/majorをするのはなぜ?
54+
本リポジトリにおけるpackage.jsonのバージョンは、masterは「次のマイナーリリースのバージョン」、aiscript-nextは「次のメジャーリリースのバージョン」の番号で保持することにしています。
55+
これは主に、毎晩自動で行われる開発中バージョンのpublishの都合に関係しています。
56+
開発中(プレリリース)バージョンのバージョン番号は、[semantic versioning 2.0の定義では](https://semver.org/lang/ja/#spec-item-9)「次回リリース予定のバージョン」にハイフンを挟んで何かしらの文字列を置くということになっています。
57+
このバージョニングを機械的に行うには、元々「次回リリース予定のバージョン」になっているpackage.jsonのバージョンに適当な文字列を接尾するという形が都合がいいのです。
58+
(ちなみに設備される文字列は、masterのプレリリースでは`dev-<リリース日時>`、aiscript-nextでは`next-<リリース日時>`になっています)

0 commit comments

Comments
 (0)