summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorkurtis-lew <kurtis.a.lew@gmail.com>2020-09-14 20:37:26 -0700
committerkurtis-lew <kurtis.a.lew@gmail.com>2020-09-14 20:37:26 -0700
commit1a492f0f9847d4c4f7e992c32b52920074d76ee4 (patch)
tree15808cc90796c16743e24f4c00a49f9ef30be260 /docs
parent98098dbe21d96d75adbbbc2f7f375b85ce0c055e (diff)
Updated dev guide
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/dev-guide-new-shield.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/docs/dev-guide-new-shield.md b/docs/docs/dev-guide-new-shield.md
index 6140b07..71af54e 100644
--- a/docs/docs/dev-guide-new-shield.md
+++ b/docs/docs/dev-guide-new-shield.md
@@ -18,6 +18,9 @@ The high level steps are:
- Add a default keymap, which users can override in their own configs as needed.
- Add support for features such as encoders, OLED displays, or RGB underglow.
+
+- Update build.yml
+
It may be helpful to review the upstream [shields documentation](https://docs.zephyrproject.org/2.3.0/guides/porting/shields.html#shields) to get a proper understanding of the underlying system before continuing.
## New Shield Directory
@@ -302,3 +305,36 @@ and then flash with:
```
west flash
```
+
+## 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 \ No newline at end of file