diff options
| author | Peter Johanson <peter@peterjohanson.com> | 2021-09-10 05:40:36 +0000 |
|---|---|---|
| committer | Pete Johanson <peter@peterjohanson.com> | 2021-09-11 00:50:36 -0400 |
| commit | 7bf68f2a0024accaeed3ba1abdbe075b2d29ccb2 (patch) | |
| tree | 882e64937b210aec2ccf609a17e6ee70af6c529a | |
| parent | 0c3f1309c619a619fc466e4204f0ed73ff8dd21a (diff) | |
refactor(docs): Remove build.yml for new shield.
* No longer recommending that all new shields get added to the
build matrix in `build.yml`, so we avoid conflicts.
| -rw-r--r-- | docs/docs/development/new-shield.md | 34 |
1 files changed, 0 insertions, 34 deletions
diff --git a/docs/docs/development/new-shield.md b/docs/docs/development/new-shield.md index 2ed2b12..83b1fc6 100644 --- a/docs/docs/development/new-shield.md +++ b/docs/docs/development/new-shield.md @@ -509,37 +509,3 @@ Please have a look at documentation specific to Further testing your keyboard shield without altering the root keymap file can be done with the use of `-DZMK_CONFIG` in your `west build` command, shown [here](build-flash.md#building-from-zmk-config-folder) ::: - -## Updating `build.yml` - -Before publishing your shield to the public via a PR, navigate to `build.yml` found in `.github/workflows` and add your shield to the appropriate list. An example edit to `build.yml` is shown below. - -``` -jobs: - build: - runs-on: ubuntu-latest - name: Build Test - strategy: - matrix: - board: [proton_c, nice_nano, bluemicro840_v1, nrfmicro_13] - shield: - - corne_left - - corne_right - - kyria_left - - kyria_right - - lily58_left - - lily58_right - - iris_left - - iris_right - - romac - - <MY_BOARD> - - <MY_SPLIT_BOARD_left> - - <MY_SPLIT_BOARD_right> - include: - - board: proton_c - shield: clueboard_california -``` - -:::note -Notice that both the left and right halves of a split board need to be added to the list of shields for proper error checking. -:::note |