diff options
| author | fauxpark <fauxpark@gmail.com> | 2021-06-20 12:10:59 +1000 |
|---|---|---|
| committer | fauxpark <fauxpark@gmail.com> | 2021-06-20 12:10:59 +1000 |
| commit | e3030bff5e6b241ef8934ddaf84e524d0fd32bce (patch) | |
| tree | 976aa1cc9d25c884ecedc548ce507404904414a3 /docs/breaking_changes.md | |
| parent | 5b7cf9fdc86bf92b465565b2be5d501ea9529f37 (diff) | |
| parent | 4dddcb4f0300f79d8fbfc462ff8d6b360e99989e (diff) | |
| download | qmk_firmware-e3030bff5e6b241ef8934ddaf84e524d0fd32bce.tar.gz qmk_firmware-e3030bff5e6b241ef8934ddaf84e524d0fd32bce.zip | |
Merge remote-tracking branch 'upstream/master' into develop
Diffstat (limited to 'docs/breaking_changes.md')
| -rw-r--r-- | docs/breaking_changes.md | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/breaking_changes.md b/docs/breaking_changes.md index 2ad8b5a14..a1a56bd45 100644 --- a/docs/breaking_changes.md +++ b/docs/breaking_changes.md | |||
| @@ -56,7 +56,7 @@ This happens immediately after the previous `develop` branch is merged. | |||
| 56 | * [ ] `git commit -m 'Branch point for <DATE> Breaking Change'` | 56 | * [ ] `git commit -m 'Branch point for <DATE> Breaking Change'` |
| 57 | * [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>` | 57 | * [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>` |
| 58 | * [ ] `git tag <next_version>` # Prevent the breakpoint tag from confusing version incrementing | 58 | * [ ] `git tag <next_version>` # Prevent the breakpoint tag from confusing version incrementing |
| 59 | * [ ] `git push origin develop` | 59 | * [ ] `git push upstream develop` |
| 60 | * [ ] `git push --tags` | 60 | * [ ] `git push --tags` |
| 61 | 61 | ||
| 62 | ## 4 Weeks Before Merge | 62 | ## 4 Weeks Before Merge |
| @@ -86,17 +86,21 @@ This happens immediately after the previous `develop` branch is merged. | |||
| 86 | * `qmk_firmware` git commands | 86 | * `qmk_firmware` git commands |
| 87 | * [ ] `git checkout develop` | 87 | * [ ] `git checkout develop` |
| 88 | * [ ] `git pull --ff-only` | 88 | * [ ] `git pull --ff-only` |
| 89 | * [ ] `git rebase origin/master` | ||
| 90 | * [ ] Edit `readme.md` | 89 | * [ ] Edit `readme.md` |
| 91 | * [ ] Remove the notes about `develop` | 90 | * [ ] Remove the notes about `develop` |
| 92 | * [ ] Roll up the ChangeLog into one file. | 91 | * [ ] Roll up the ChangeLog into one file. |
| 93 | * [ ] `git commit -m 'Merge point for <DATE> Breaking Change'` | 92 | * [ ] `git commit -m 'Merge point for <DATE> Breaking Change'` |
| 94 | * [ ] `git push origin develop` | 93 | * [ ] `git push upstream develop` |
| 95 | * GitHub Actions | 94 | * GitHub Actions |
| 96 | * [ ] Create a PR for `develop` | 95 | * [ ] Create a PR for `develop` |
| 97 | * [ ] Make sure travis comes back clean | 96 | * [ ] Make sure travis comes back clean |
| 98 | * [ ] Merge `develop` PR | 97 | * [ ] **Turn off 'Automatically delete head branches' for the repository** -- confirm with @qmk/directors that it is done before continuing |
| 98 | * `qmk_firmware` git commands | ||
| 99 | * [ ] `git checkout master` | ||
| 100 | * [ ] `git pull --ff-only` | ||
| 101 | * [ ] `git merge --no-ff develop` | ||
| 102 | * [ ] `git push upstream master` | ||
| 99 | 103 | ||
| 100 | ## Post-merge operations | 104 | ## Post-merge operations |
| 101 | 105 | ||
| 102 | * (Optional) [update ChibiOS + ChibiOS-Contrib on `develop`](chibios_upgrade_instructions.md) \ No newline at end of file | 106 | * (Optional) [update ChibiOS + ChibiOS-Contrib on `develop`](chibios_upgrade_instructions.md) |
