Build in Github Pipeline

gittyeric / ergodox-macro-hax

A hack to get around the 4-button max Macro limit in Oryx for Ergodox / Moonlander keyboards.

29 stars 0 forks source link

Build in Github Pipeline #1

Closed Phoscur closed 2 years ago

Phoscur commented 2 years ago

Hi! I am just setting up my QMK build env - still new to my Moonlander - but I am already wondering if we could use Github to download from ORXY and build firmware on demand in a reusable way (and maybe skipping a local QMK install)...

What do you think of the idea of making it easy to create and publish macros by forking/configuring your TypeScript helper?

eric-fulfil commented 2 years ago

That would be pretty slick! I'd be happy to merge the fork in if you get something going. I've personally switched to Ultimate Hacking Keyboard because the macro support is so good out of the box, but it'd be awesome if someone grabbed the baton.

Phoscur commented 2 years ago

Thank you for your feedback! I am still getting used to my moonlander. I loved to see you do this in TypeScript xD Now I've read into the keymap C code, I think it makes sense to keep this as a postprocessor...

Missing features:

download latest source from oryx
build qmk firmware after postprocessing keymap source (- document/improve creating new macros by forking the repo)

Those could then be configured and triggered in Github pipelines, producing firmware binaries again.

Phoscur commented 2 years ago

Quick wip poc for the download & unzip: https://github.com/Phoscur/ergodox-macro-hax/commit/71640163256de00b2c5ef0e483c740c26330badf

Probably also need to parse the ORYX page for some more information (the link to download the source).

Phoscur commented 2 years ago

That would be pretty slick! I'd be happy to merge the fork in if you get something going. I've personally switched to Ultimate Hacking Keyboard because the macro support is so good out of the box, but it'd be awesome if someone grabbed the baton.

So you want to review and help for drafting/planning (only)?

eric-fulfil commented 2 years ago

That would be pretty slick! I'd be happy to merge the fork in if you get something going. I've personally switched to Ultimate Hacking Keyboard because the macro support is so good out of the box, but it'd be awesome if someone grabbed the baton.

So you want to review and help for drafting/planning (only)?

Most of my keyboard customization time is going into a free keyboard designer app so yeah I don't have much more time than this than reviewing but I'd be happy to make you admin on this repo or whatever after a few pull request reviews.

Phoscur commented 2 years ago

Do you still have the ergodex, so you could run a full test with that if the pipeline is done? Would be nice to test something else than my moonlander too if we want to make this more generic and reusable. I am unsure how this generalises beyond QMK, so I don't know if the concept can also be applied for your Ultimate Hacking Keyboard.

make you admin on this repo

We could indeed keep this one to fork from, I'll see if I can offload/modularize into smaller projects as needed (so this one is only about macros.

eric-fulfil commented 2 years ago

Ha I actually only have a Moonlander as well. If you open a Pull Request with those Axios changes I'll review it and give you write access or whatever it's called if all goes well.

Phoscur commented 2 years ago

After having had success with the ORYX GraphQL API (#3), I created a Github Action, that already does the macro post-processing: https://github.com/Phoscur/ergodox-macro-hax/commit/db24a684adba96fdee9deeced0c96f1554d5bbef So now the last piece of the puzzle is to compile and publish as an artifact.