121 lines
5 KiB
Markdown
121 lines
5 KiB
Markdown
|
# Breaking changes/互換性を破る変更
|
||
|
|
|
||
|
|
<!---
|
||
|
|
grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
|
||
|
|
original document: 0.9.0:docs/breaking_changes.md
|
||
|
|
git diff 0.9.0 HEAD -- docs/breaking_changes.md | cat
|
||
|
|
-->
|
||
|
|
|
||
|
|
このドキュメントは QMK の互換性を破る変更(Breaking change) のプロセスについて説明します。
|
||
|
|
互換性を破る変更とは、互換性がなかったり潜在的な危険が生じるように QMK の動作を変える変更を指します。
|
||
|
|
ユーザが QMK ツリーを更新しても自分のキーマップが壊れない事を確信できるように、これらの変更を制限します。(訳注：以後、原文のまま Breaking change を用語として使用します。)
|
||
|
|
|
||
|
|
Breaking change ピリオドとは、危険な変更、または予想外の変更を QMK へ行なう PR をマージする時のことです。
|
||
|
|
付随するテスト期間があるため、問題が起きることはまれか、有りえないと確信しています。
|
||
|
|
|
||
|
|
## 過去の Breaking change には何が含まれますか？
|
||
|
|
|
||
|
|
* [2020年5月30日](ja/ChangeLog/20200530.md)
|
||
|
|
* [2020年2月29日](ja/ChangeLog/20200229.md)
|
||
|
|
* [2019年8月30日](ja/ChangeLog/20190830.md)
|
||
|
|
|
||
|
|
## 次の Breaking change はいつですか？
|
||
|
|
|
||
|
|
次の Breaking change は2020年8月29日に予定されています。
|
||
|
|
|
||
|
|
### 重要な日付
|
||
|
|
|
||
|
|
* [x] 2020年 5月30日 - `develop` が作成されました。毎週リベースされます。
|
||
|
|
* [ ] 2020年 8月 1日 - `develop` は新しいPRを取り込みません。
|
||
|
|
* [ ] 2020年 8月 1日 - テスターの募集。
|
||
|
|
* [ ] 2020年 8月27日 - `master`がロックされ、PR はマージされません。
|
||
|
|
* [ ] 2020年 8月29日 - `develop` を `master` にマージします。
|
||
|
|
* [ ] 2020年 8月29日 - `master` のロックが解除されます。PR を再びマージすることができます。
|
||
|
|
|
||
|
|
## どのような変更が含まれますか？
|
||
|
|
|
||
|
|
最新の Breaking change 候補を見るには、[`breaking_change` ラベル](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+label%3Abreaking_change+is%3Apr)を参照してください。
|
||
|
|
現在から `develop` が閉じられるまでの間に新しい変更が追加される可能性があり、そのラベルが適用された PR はマージされることは保証されていません。
|
||
|
|
|
||
|
|
このラウンドに、あなたの Breaking change を含めたい場合は、`breaking_change` ラベルを持つ PR を作成し、`develop` が閉じる前に承認してもらう必要があります。
|
||
|
|
`develop` が閉じた後は、新しい Breaking change は受け付けられません。
|
||
|
|
|
||
|
|
受け入れの基準:
|
||
|
|
|
||
|
|
* PR が完了し、マージの準備ができている
|
||
|
|
* PR が ChangeLog を持つ
|
||
|
|
|
||
|
|
# チェックリスト
|
||
|
|
|
||
|
|
ここでは、Breaking change プロセスを実行する時に使用する様々なプロセスについて説明します。
|
||
|
|
|
||
|
|
## `master` から `develop` をリベースします
|
||
|
|
|
||
|
|
これは `develop` が開いている間、毎週金曜日に実行されます。
|
||
|
|
|
||
|
|
プロセス:
|
||
|
|
|
||
|
|
```
|
||
|
|
cd qmk_firmware
|
||
|
|
git checkout master
|
||
|
|
git pull --ff-only
|
||
|
|
git checkout develop
|
||
|
|
git rebase master
|
||
|
|
git push --force
|
||
|
|
```
|
||
|
|
|
||
|
|
## `develop` ブランチの作成
|
||
|
|
|
||
|
|
以前の `develop` ブランチがマージされた直後に、これが発生します。
|
||
|
|
|
||
|
|
* `qmk_firmware` git commands
|
||
|
|
* [ ] `git checkout master`
|
||
|
|
* [ ] `git pull --ff-only`
|
||
|
|
* [ ] `git checkout -b develop`
|
||
|
|
* [ ] Edit `readme.md`
|
||
|
|
* [ ] これがテストブランチであることを上部に大きな通知で追加します。
|
||
|
|
* [ ] このドキュメントへのリンクを含めます
|
||
|
|
* [ ] `git commit -m 'Branch point for <DATE> Breaking Change'`
|
||
|
|
* [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>`
|
||
|
|
* [ ] `git tag <next_version>` # ブレーキング ポイント タグがバージョンの増分を混乱させないようにします
|
||
|
|
* [ ] `git push origin develop`
|
||
|
|
* [ ] `git push --tags`
|
||
|
|
|
||
|
|
## マージの 4 週間前
|
||
|
|
|
||
|
|
* `develop` は新しい PR に対して閉じられ、現在の PR の修正のみがマージされる可能性があります。
|
||
|
|
* テスターの呼び出しを投稿します
|
||
|
|
* [ ] Discord
|
||
|
|
* [ ] GitHub PR
|
||
|
|
* [ ] https://reddit.com/r/olkb
|
||
|
|
|
||
|
|
## マージの 1 週間前
|
||
|
|
|
||
|
|
* master が < 2 日前> から <マージの日> まで閉じられることを発表します
|
||
|
|
* [ ] Discord
|
||
|
|
* [ ] GitHub PR
|
||
|
|
* [ ] https://reddit.com/r/olkb
|
||
|
|
|
||
|
|
## マージの 2 日前
|
||
|
|
|
||
|
|
* master が 2 日間閉じられることを発表します
|
||
|
|
* [ ] Discord
|
||
|
|
* [ ] GitHub PR
|
||
|
|
* [ ] https://reddit.com/r/olkb
|
||
|
|
|
||
|
|
## マージの日
|
||
|
|
|
||
|
|
* `qmk_firmware` git commands
|
||
|
|
* [ ] `git checkout develop`
|
||
|
|
* [ ] `git pull --ff-only`
|
||
|
|
* [ ] `git rebase origin/master`
|
||
|
|
* [ ] Edit `readme.md`
|
||
|
|
* [ ] `develop` についてのメモを削除
|
||
|
|
* [ ] ChangeLog を 1 つのファイルにまとめます。
|
||
|
|
* [ ] `git commit -m 'Merge point for <DATE> Breaking Change'`
|
||
|
|
* [ ] `git push origin develop`
|
||
|
|
* GitHub Actions
|
||
|
|
* [ ] `develop`の PR を作成します
|
||
|
|
* [ ] travis がクリーンに戻ったことを確認します
|
||
|
|
* [ ] `develop` PR をマージします
|