aboutsummaryrefslogtreecommitdiff
path: root/docs/breaking_changes.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2020-05-30 13:14:59 -0700
committerGitHub <noreply@github.com>2020-05-30 13:14:59 -0700
commitfced377ac007d27f2650ccffbe0b18abcdcfe23d (patch)
treebd5b141987394a5a16cfc416bfe2b9efdb14d067 /docs/breaking_changes.md
parent7b8a013826ad90714a05ea522de53adf964ab3b9 (diff)
downloadqmk_firmware-fced377ac007d27f2650ccffbe0b18abcdcfe23d.tar.gz
qmk_firmware-fced377ac007d27f2650ccffbe0b18abcdcfe23d.zip
2020 May 30 Breaking Changes Update (#9215)
* Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) * Convert V-USB usbdrv to a submodule (#8321) * Unify Tap Hold functions and documentation (#8348) * Changing board names to prevent confusion (#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (#8499) * Move spaceman keyboards (#8830) * Migrate miscellaneous `fn_actions` entries (#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (#8537) * Refactor Lily58 to use split_common (#6260) * Refactor zinc to use split_common (#7114) * Add a message if bin/qmk doesn't work (#9000) * Fix conflicting types for 'tfp_printf' (#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480) * Refactor and updates to TKC1800 code (#8472) * Switch to qmk forks for everything (#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484) * Audio enable corrections (2/3) (#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582) * Audio enable corrections (Part 4) (#8974) * Fix typo from PR7114 (#9171) * Augment future branch Changelogs (#8978) * Revert "Branch point for 2020 May 30 Breaking Change"
Diffstat (limited to 'docs/breaking_changes.md')
-rw-r--r--docs/breaking_changes.md45
1 files changed, 23 insertions, 22 deletions
diff --git a/docs/breaking_changes.md b/docs/breaking_changes.md
index 6c684970d..154695dda 100644
--- a/docs/breaking_changes.md
+++ b/docs/breaking_changes.md
@@ -6,27 +6,28 @@ The breaking change period is when we will merge PR's that change QMK in dangero
6 6
7## What has been included in past Breaking Changes? 7## What has been included in past Breaking Changes?
8 8
9* [2020 May 30](ChangeLog/20200530.md)
9* [2020 Feb 29](ChangeLog/20200229.md) 10* [2020 Feb 29](ChangeLog/20200229.md)
10* [2019 Aug 30](ChangeLog/20190830.md) 11* [2019 Aug 30](ChangeLog/20190830.md)
11 12
12## When is the next Breaking Change? 13## When is the next Breaking Change?
13 14
14The next Breaking Change is scheduled for May 30, 2020. 15The next Breaking Change is scheduled for Aug 29, 2020.
15 16
16### Important Dates 17### Important Dates
17 18
18* [x] 2020 Feb 29 - `future` is created. It will be rebased weekly. 19* [x] 2020 May 30 - `develop` is created. It will be rebased weekly.
19* [ ] 2020 May 2 - `future` closed to new PR's. 20* [ ] 2020 Aug 1 - `develop` closed to new PR's.
20* [ ] 2020 May 2 - Call for testers. 21* [ ] 2020 Aug 1 - Call for testers.
21* [ ] 2020 May 28 - `master` is locked, no PR's merged. 22* [ ] 2020 Aug 27 - `master` is locked, no PR's merged.
22* [ ] 2020 May 30 - Merge `future` to `master`. 23* [ ] 2020 Aug 29 - Merge `develop` to `master`.
23* [ ] 2020 May 30 - `master` is unlocked. PR's can be merged again. 24* [ ] 2020 Aug 29 - `master` is unlocked. PR's can be merged again.
24 25
25## What changes will be included? 26## What changes will be included?
26 27
27To see a list of breaking change candidates you can look at the [`breaking_change` label](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+label%3Abreaking_change+is%3Apr). New changes might be added between now and when `future` is closed, and a PR with that label applied is not guaranteed to be merged. 28To see a list of breaking change candidates you can look at the [`breaking_change` label](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+label%3Abreaking_change+is%3Apr). New changes might be added between now and when `develop` is closed, and a PR with that label applied is not guaranteed to be merged.
28 29
29If you want your breaking change to be included in this round you need to create a PR with the `breaking_change` label and have it accepted before `future` closes. After `future` closes no new breaking changes will be accepted. 30If you want your breaking change to be included in this round you need to create a PR with the `breaking_change` label and have it accepted before `develop` closes. After `develop` closes no new breaking changes will be accepted.
30 31
31Criteria for acceptance: 32Criteria for acceptance:
32 33
@@ -37,9 +38,9 @@ Criteria for acceptance:
37 38
38This section documents various processes we use when running the Breaking Changes process. 39This section documents various processes we use when running the Breaking Changes process.
39 40
40## Rebase `future` from `master` 41## Rebase `develop` from `master`
41 42
42This is run every Friday while `future` is open. 43This is run every Friday while `develop` is open.
43 44
44Process: 45Process:
45 46
@@ -47,31 +48,31 @@ Process:
47cd qmk_firmware 48cd qmk_firmware
48git checkout master 49git checkout master
49git pull --ff-only 50git pull --ff-only
50git checkout future 51git checkout develop
51git rebase master 52git rebase master
52git push --force 53git push --force
53``` 54```
54 55
55## Creating the `future` branch 56## Creating the `develop` branch
56 57
57This happens immediately after the previous `future` branch is merged. 58This happens immediately after the previous `develop` branch is merged.
58 59
59* `qmk_firmware` git commands 60* `qmk_firmware` git commands
60 * [ ] `git checkout master` 61 * [ ] `git checkout master`
61 * [ ] `git pull --ff-only` 62 * [ ] `git pull --ff-only`
62 * [ ] `git checkout -b future` 63 * [ ] `git checkout -b develop`
63 * [ ] Edit `readme.md` 64 * [ ] Edit `readme.md`
64 * [ ] Add a big notice at the top that this is a testing branch. 65 * [ ] Add a big notice at the top that this is a testing branch.
65 * [ ] Include a link to this document 66 * [ ] Include a link to this document
66 * [ ] `git commit -m 'Branch point for <DATE> Breaking Change'` 67 * [ ] `git commit -m 'Branch point for <DATE> Breaking Change'`
67 * [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>` 68 * [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>`
68 * [ ] `git tag <next_version>` # Prevent the breakpoint tag from confusing version incrementing 69 * [ ] `git tag <next_version>` # Prevent the breakpoint tag from confusing version incrementing
69 * [ ] `git push origin future` 70 * [ ] `git push origin develop`
70 * [ ] `git push --tags` 71 * [ ] `git push --tags`
71 72
72## 4 Weeks Before Merge 73## 4 Weeks Before Merge
73 74
74* `future` is now closed to new PR's, only fixes for current PR's may be merged 75* `develop` is now closed to new PR's, only fixes for current PR's may be merged
75* Post call for testers 76* Post call for testers
76 * [ ] Discord 77 * [ ] Discord
77 * [ ] GitHub PR 78 * [ ] GitHub PR
@@ -94,15 +95,15 @@ This happens immediately after the previous `future` branch is merged.
94## Day Of Merge 95## Day Of Merge
95 96
96* `qmk_firmware` git commands 97* `qmk_firmware` git commands
97 * [ ] `git checkout future` 98 * [ ] `git checkout develop`
98 * [ ] `git pull --ff-only` 99 * [ ] `git pull --ff-only`
99 * [ ] `git rebase origin/master` 100 * [ ] `git rebase origin/master`
100 * [ ] Edit `readme.md` 101 * [ ] Edit `readme.md`
101 * [ ] Remove the notes about `future` 102 * [ ] Remove the notes about `develop`
102 * [ ] Roll up the ChangeLog into one file. 103 * [ ] Roll up the ChangeLog into one file.
103 * [ ] `git commit -m 'Merge point for <DATE> Breaking Change'` 104 * [ ] `git commit -m 'Merge point for <DATE> Breaking Change'`
104 * [ ] `git push origin future` 105 * [ ] `git push origin develop`
105* GitHub Actions 106* GitHub Actions
106 * [ ] Create a PR for `future` 107 * [ ] Create a PR for `develop`
107 * [ ] Make sure travis comes back clean 108 * [ ] Make sure travis comes back clean
108 * [ ] Merge `future` PR 109 * [ ] Merge `develop` PR