zmk icon indicating copy to clipboard operation
zmk copied to clipboard

[GH Actions] Make it possible to run build process from subdirectory

Open suttonbradley opened this issue 1 year ago • 2 comments

I'm hoping to be able to contain my keyboard design (ergogen/other) files and my ZMK config within the same directory in a clean way, like having a subdirectory zmk-config and having the github action for building firmware run with that dir as a working directory.

I see that the GH actions yaml takes four inputs, and I tried setting those in my usage of the build-user-config.yaml template.

Links for reference:

suttonbradley avatar Aug 13 '24 16:08 suttonbradley

I think you should be able to do this by setting the working directory. That said I'd push back against documenting this, I don't think this approach should be recommended.

EDIT: a better approach could be to have your zmk config be a git submodule of your keyboard's repo.

nmunnich avatar Aug 13 '24 20:08 nmunnich

i just run into the same issue, and I'm not sure why this is contested. seems pretty reasonable request.

yes submodules might be an option but they're also a mess to maintain, especially if on is developing several keyboards. adding a couple of lines to a config is a better experience however you turn it

@suttonbradley did you by any chance figure out how to make the default working directory setting work?

kaievns avatar Oct 10 '24 04:10 kaievns