search

urob / zmk-helpers

Convenience macros simplifying ZMK's keymap configuration
MIT License
235 stars 79 forks source link

add submodule to custom-shield #39

Closed Finnitio closed 2 months ago

Finnitio commented 5 months ago

Hello urob,

i have created a custom shield for my 3d printed handwired corne keyboard. That works until I would like to integrate the nodefree submodule and build it via github actions. Build error when building it tries to find "3dpcorne" shield from the official keyboards. It does not recognize the shield within the repository for building the firmware. How can i build the firmware with the custom shield?

urob commented 2 months ago

Sorry for the late response. It looks like you used to add the repo as git-submodule. Going that route also requires switching to a custom GHA workflow as the default action doesn't check out submodules. There's some more details on this approach under "Manual Installation" (and the footnote there) in https://github.com/urob/zmk-helpers/tree/v2?tab=readme-ov-file#installation.

However, with version 2, using git-submodule is no longer the recommended approach. It is now recommended to use load the new west module instead. Alternatively, just copying the files into your config as you ended up doing also works well.