From dab63d554086823af6844b556b7471fd4a86e6d2 Mon Sep 17 00:00:00 2001 From: Manna Harbour <51143715+manna-harbour@users.noreply.github.com> Date: Thu, 7 Apr 2022 10:19:04 +1000 Subject: [PATCH] Refactor workflow and outboards - change "merge" option to "branches" - use first branch as base and merge rest - use "zmk" file instead of manifest - checkout to subdirectories - checkout zmk manually - use west just for zephyr - use absolute paths - handle simultaneous board and shield outboards - change outboard and directory names --- ...yspr.yml => build-example-mousekeyspr.yml} | 4 +- .github/workflows/build-inputs.yml | 8 +- .github/workflows/main.yml | 205 +++++++----------- .../ahokore} | 0 .../ble_chiffre} | 0 .../workflows/outboards/boards/corne-ish_zen | 4 + .../workflows/outboards/boards/ferris_rev02 | 4 + .../{one42.outboard => boards/one42} | 0 .../preonic_rev3} | 0 .../outboards/boards/sparkfun_nrf52840_mini | 9 + .../technikable} | 0 .../{zaphod.outboard => boards/zaphod} | 3 +- .../outboards/corne-ish_zen.outboard | 5 - .../workflows/outboards/ferris_rev02.outboard | 5 - .../workflows/outboards/microdox_mod.outboard | 9 - .../{absolem.outboard => shields/absolem} | 0 .../ahokore} | 0 .../{arch36.outboard => shields/arch36} | 0 .../{bastyl.outboard => shields/bastyl} | 0 .../{bat43.outboard => shields/bat43} | 0 .../{berylline.outboard => shields/berylline} | 0 .../boardsource5x12} | 0 .../{chocv.outboard => shields/chocv} | 0 .../{contra.outboard => shields/contra} | 0 .../{draculad.outboard => shields/draculad} | 0 .../{ergodash.outboard => shields/ergodash} | 0 .../ergotravel} | 0 .../gatoraid40} | 0 .../{hillside.outboard => shields/hillside} | 0 .../{horizon.outboard => shields/horizon} | 0 .../hummingbird} | 0 .../{levinson.outboard => shields/levinson} | 0 .../workflows/outboards/shields/microdox_mod | 9 + .../pockettype} | 0 .../{pteron36.outboard => shields/pteron36} | 0 .../rebound_v4} | 0 .../{reviung39.outboard => shields/reviung39} | 0 .../scylla_dmmpcb} | 0 .../{sofle_rgb.outboard => shields/sofle_rgb} | 0 .../{tbkmini.outboard => shields/tbkmini} | 0 .../{tightyl.outboard => shields/tightyl} | 0 .../{viterbi.outboard => shields/viterbi} | 0 .../zaphod_lite} | 0 .github/workflows/zmk | 4 + config/west.yml | 11 - readme.org | 14 +- 46 files changed, 127 insertions(+), 167 deletions(-) rename .github/workflows/{build-example-corne-nice_nano-mousekeyspr.yml => build-example-mousekeyspr.yml} (76%) rename .github/workflows/outboards/{ahokore.board.outboard => boards/ahokore} (100%) rename .github/workflows/outboards/{ble_chiffre.outboard => boards/ble_chiffre} (100%) create mode 100644 .github/workflows/outboards/boards/corne-ish_zen create mode 100644 .github/workflows/outboards/boards/ferris_rev02 rename .github/workflows/outboards/{one42.outboard => boards/one42} (100%) rename .github/workflows/outboards/{preonic_rev3.outboard => boards/preonic_rev3} (100%) create mode 100644 .github/workflows/outboards/boards/sparkfun_nrf52840_mini rename .github/workflows/outboards/{technikable.outboard => boards/technikable} (100%) rename .github/workflows/outboards/{zaphod.outboard => boards/zaphod} (74%) delete mode 100644 .github/workflows/outboards/corne-ish_zen.outboard delete mode 100644 .github/workflows/outboards/ferris_rev02.outboard delete mode 100644 .github/workflows/outboards/microdox_mod.outboard rename .github/workflows/outboards/{absolem.outboard => shields/absolem} (100%) rename .github/workflows/outboards/{ahokore.shield.outboard => shields/ahokore} (100%) rename .github/workflows/outboards/{arch36.outboard => shields/arch36} (100%) rename .github/workflows/outboards/{bastyl.outboard => shields/bastyl} (100%) rename .github/workflows/outboards/{bat43.outboard => shields/bat43} (100%) rename .github/workflows/outboards/{berylline.outboard => shields/berylline} (100%) rename .github/workflows/outboards/{boardsource5x12.outboard => shields/boardsource5x12} (100%) rename .github/workflows/outboards/{chocv.outboard => shields/chocv} (100%) rename .github/workflows/outboards/{contra.outboard => shields/contra} (100%) rename .github/workflows/outboards/{draculad.outboard => shields/draculad} (100%) rename .github/workflows/outboards/{ergodash.outboard => shields/ergodash} (100%) rename .github/workflows/outboards/{ergotravel.outboard => shields/ergotravel} (100%) rename .github/workflows/outboards/{gatoraid40.outboard => shields/gatoraid40} (100%) rename .github/workflows/outboards/{hillside.outboard => shields/hillside} (100%) rename .github/workflows/outboards/{horizon.outboard => shields/horizon} (100%) rename .github/workflows/outboards/{hummingbird.outboard => shields/hummingbird} (100%) rename .github/workflows/outboards/{levinson.outboard => shields/levinson} (100%) create mode 100644 .github/workflows/outboards/shields/microdox_mod rename .github/workflows/outboards/{pockettype.outboard => shields/pockettype} (100%) rename .github/workflows/outboards/{pteron36.outboard => shields/pteron36} (100%) rename .github/workflows/outboards/{rebound_v4.outboard => shields/rebound_v4} (100%) rename .github/workflows/outboards/{reviung39.outboard => shields/reviung39} (100%) rename .github/workflows/outboards/{scylla_dmmpcb.outboard => shields/scylla_dmmpcb} (100%) rename .github/workflows/outboards/{sofle_rgb.outboard => shields/sofle_rgb} (100%) rename .github/workflows/outboards/{tbkmini.outboard => shields/tbkmini} (100%) rename .github/workflows/outboards/{tightyl.outboard => shields/tightyl} (100%) rename .github/workflows/outboards/{viterbi.outboard => shields/viterbi} (100%) rename .github/workflows/outboards/{zaphod_lite.outboard => shields/zaphod_lite} (100%) create mode 100644 .github/workflows/zmk delete mode 100644 config/west.yml diff --git a/.github/workflows/build-example-corne-nice_nano-mousekeyspr.yml b/.github/workflows/build-example-mousekeyspr.yml similarity index 76% rename from .github/workflows/build-example-corne-nice_nano-mousekeyspr.yml rename to .github/workflows/build-example-mousekeyspr.yml index 2d10182b9..5c86fd2ae 100644 --- a/.github/workflows/build-example-corne-nice_nano-mousekeyspr.yml +++ b/.github/workflows/build-example-mousekeyspr.yml @@ -1,7 +1,7 @@ # Copyright 2022 Manna Harbour # https://github.com/manna-harbour/miryoku -name: 'Build Example corne nice_nano mousekeyspr' +name: 'Build Example mousekeyspr' on: workflow_dispatch: jobs: @@ -12,4 +12,4 @@ jobs: shield: '["corne_left","corne_right"]' config: '["#define MIRYOKU_KLUDEGE_MOUSEKEYSPR"]' kconfig: '["CONFIG_ZMK_MOUSE=y"]' - merge: '["=krikun98/zmk/mouse-pr"]' + branches: '["zmkfirmware/zmk/main krikun98/zmk/mouse-pr","krikun98/zmk/mouse-pr"]' diff --git a/.github/workflows/build-inputs.yml b/.github/workflows/build-inputs.yml index 0f0c01ef0..93d32da6f 100644 --- a/.github/workflows/build-inputs.yml +++ b/.github/workflows/build-inputs.yml @@ -40,7 +40,7 @@ on: description: 'Kconfig' required: false default: 'default' - merge: + branches: description: 'ZMK Branches' required: false default: 'default' @@ -57,7 +57,7 @@ jobs: mapping: ${{ steps.process-inputs.outputs.mapping }} config: ${{ steps.process-inputs.outputs.config }} kconfig: ${{ steps.process-inputs.outputs.kconfig }} - merge: ${{ steps.process-inputs.outputs.merge }} + branches: ${{ steps.process-inputs.outputs.branches }} steps: - name: Process inputs id: process-inputs @@ -76,7 +76,7 @@ jobs: set-output "mapping" "${{ github.event.inputs.mapping }}" set-output "config" "${{ github.event.inputs.config }}" set-output "kconfig" "${{ github.event.inputs.kconfig }}" - set-output "merge" "${{ github.event.inputs.merge }}" + set-output "branches" "${{ github.event.inputs.branches }}" build: uses: manna-harbour/zmk-config/.github/workflows/main.yml@31a649e5571b4572d7010561dd3f191922cd9410 needs: process-inputs @@ -90,4 +90,4 @@ jobs: mapping: ${{ needs.process-inputs.outputs.mapping }} config: ${{ needs.process-inputs.outputs.config }} kconfig: ${{ needs.process-inputs.outputs.kconfig }} - merge: ${{ needs.process-inputs.outputs.merge }} + branches: ${{ needs.process-inputs.outputs.branches }} diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 239db5540..df223fe3a 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -32,7 +32,7 @@ on: kconfig: type: string default: '["default"]' - merge: + branches: type: string default: '["default"]' @@ -53,11 +53,13 @@ jobs: mapping: ${{ fromJSON(inputs.mapping) }} config: ${{ fromJSON(inputs.config) }} kconfig: ${{ fromJSON(inputs.kconfig) }} - merge: ${{ fromJSON(inputs.merge) }} + branches: ${{ fromJSON(inputs.branches) }} steps: - - name: Checkout - uses: actions/checkout@v2 - - name: Process variables + - name: checkout + uses: actions/checkout@v3 + with: + path: 'miryoku_zmk' + - name: main id: variables run: | if [ -n "${{ matrix.shield }}" -a "${{ matrix.shield }}" != "default" ] @@ -73,7 +75,7 @@ jobs: keyboard_split="$keyboard" keyboard_base=`echo "$keyboard" | sed 's/_\(left\|right\)//'` - configfile="${GITHUB_WORKSPACE}/miryoku/custom_config.h" + configfile="${GITHUB_WORKSPACE}/miryoku_zmk/miryoku/custom_config.h" echo "::set-output name=configfile::$configfile" artifact_build_name="miryoku_zmk $shield ${{ matrix.board }}" @@ -96,160 +98,119 @@ jobs: esac done - artifacts_dir="artifacts" + artifacts_dir="${GITHUB_WORKSPACE}/artifacts" echo "::set-output name=artifact-dir::$artifacts_dir" mkdir "$artifacts_dir" cp "$configfile" "$artifacts_dir" - cat "$configfile" if [ -n "${{ matrix.kconfig }}" -a "${{ matrix.kconfig }}" != 'default' ] then - kconfig_file="config/$keyboard_split.conf" + kconfig_file="${GITHUB_WORKSPACE}/miryoku_zmk/config/$keyboard_split.conf" echo "${{ matrix.kconfig }}" >> "$kconfig_file" cp "$kconfig_file" "$artifacts_dir" - cat "$kconfig_file" artifact_build_name="$artifact_build_name kconfig_"`echo "${{ matrix.kconfig }}" | md5sum | cut -d ' ' -f 1` fi - if [ -n "${{ matrix.merge }}" -a "${{ matrix.merge }}" != 'default' ] - then - artifact_build_name="$artifact_build_name merge_"`echo "${{ matrix.merge }}" | md5sum | cut -d ' ' -f 1` - for branch in ${{ matrix.merge }} - do - if [ `echo "$branch" | cut -c1` = '=' ] - then - zmk=`echo "$branch" | cut -c2-` - else - merge="$merge $branch" - fi - done - fi - echo "::set-output name=merge::$merge" - echo "::set-output name=zmk::$zmk" + . "${GITHUB_WORKSPACE}/miryoku_zmk/.github/workflows/zmk" - outboard_dir=".github/workflows/outboards" if [ -n "$shield" ] then - outboard_file="$outboard_dir/$keyboard_base.shield.outboard" + outboards="shields/$keyboard_base boards/${{ matrix.board }}" else - outboard_file="$outboard_dir/$keyboard_base.board.outboard" + outboards="boards/$keyboard_base" fi - if [ ! -f "$outboard_file" ] - then - outboard_file="$outboard_dir/$keyboard_base.outboard" - fi - if [ -f "$outboard_file" ] + for outboard in $outboards + do + outboard_file="${GITHUB_WORKSPACE}/miryoku_zmk/.github/workflows/outboards/$outboard" + if [ -f "$outboard_file" ] + then + cp "$outboard_file" "$artifacts_dir" + . "$outboard_file" + outboard_dir="${GITHUB_WORKSPACE}/outboards/$outboard" + if [ -n "$outboard_repository" -a -n "$outboard_ref" ] + then + git clone -b "$outboard_ref" --depth 1 "https://github.com/$outboard_repository.git" "$outboard_dir" + if [ -n "$outboard_from" -a -n "$outboard_to" ] + then + to="${GITHUB_WORKSPACE}/miryoku_zmk/config/$outboard_to" + mkdir -p `dirname "$to"` + ln -sr "$outboard_dir/$outboard_from" "$to" + fi + fi + outboard_repository='' + outboard_ref='' + outboard_from='' + outboard_to='' + fi + done + + if [ -n "${{ matrix.branches }}" -a "${{ matrix.branches }}" != 'default' ] then - grep -v '^#' "$outboard_file" >> $GITHUB_ENV - cat "$outboard_file" - cp "$outboard_file" "$artifacts_dir" + artifact_build_name="$artifact_build_name branches_"`echo "${{ matrix.branches }}" | md5sum | cut -d ' ' -f 1` + zmk=`echo "${{ matrix.branches }}" | cut -d ' ' -f 1` + merges=`echo "${{ matrix.branches }}" | cut -d ' ' -f 2- -s` fi - echo "::set-output name=outboard_chekout_dir::outboard" artifact_build_name=`echo $artifact_build_name | tr ' ' '-'` echo "::set-output name=artifact-build-name::$artifact_build_name" echo "::set-output name=artifact-generic-name::"`echo "$artifact_build_name" | sed 's/_\(left\|right\)//'` - - name: Checkout outboard - if: ${{ env.outboard_repository != '' && env.outboard_ref != '' }} - uses: actions/checkout@v2 - with: - repository: ${{ env.outboard_repository }} - ref: ${{ env.outboard_ref }} - path: ${{ steps.variables.outputs.outboard_chekout_dir }} - - name: Link outboard - if: ${{ env.outboard_from != '' && env.outboard_to != '' }} - run: | - mkdir -p `dirname "config/${{ env.outboard_to }}"` - ln -sr ${{ steps.variables.outputs.outboard_chekout_dir }}/${{ env.outboard_from }} config/${{ env.outboard_to }} - - name: Generate manifest from outboard - if: ${{ env.outboard_url_base != '' && env.outboard_revision != '' }} - run: | - echo "manifest:\n remotes:\n - name: outboard\n url-base: ${{ env.outboard_url_base }}\n projects:\n - name: zmk\n remote: outboard\n revision: ${{ env.outboard_revision }}\n import: app/west.yml\n self:\n path: config" > config/west.yml - cat config/west.yml - - name: Copy manifest from outboard - if: ${{ env.outboard_manifest != '' }} - run: | - cp ${{ steps.variables.outputs.outboard_chekout_dir }}/${{ env.outboard_manifest }} config/west.yml - cat config/west.yml - - name: Generate manifest from merge field - if: ${{ steps.variables.outputs.zmk != '' }} - run: | - user=`echo ${{ steps.variables.outputs.zmk }} | cut -f 1 -d '/'` - repo=`echo ${{ steps.variables.outputs.zmk }} | cut -f 2 -d '/'` - branch=`echo ${{ steps.variables.outputs.zmk }} | cut -f 3- -d '/'` - remote="$user-$repo" - echo "manifest:\n remotes:\n - name: $remote\n url-base: https://github.com/$user\n projects:\n - name: zmk\n remote: $remote\n repo-path: $repo\n revision: $branch\n import: app/west.yml\n self:\n path: config" > config/west.yml - cat config/west.yml - - name: Cache zmk - if: true - uses: actions/cache@v3 - with: - path: | - zmk/ - key: zmk ${{ hashFiles('config/west.yml') }} ${{ matrix.merge }} - timeout-minutes: 2 - continue-on-error: true - - name: West init - run: west init -l config - - name: West update zmk - run: west update zmk - - name: Merge branches - if: ${{ steps.variables.outputs.merge != '' }} - run: | - cd zmk - git config user.name "${GITHUB_ACTOR}" - git config user.email "${GITHUB_ACTOR}@users.noreply.github.com" - for merge in ${{ steps.variables.outputs.merge }} - do - user=`echo "$merge" | cut -f 1 -d '/'` - repo=`echo "$merge" | cut -f 2 -d '/'` - branch=`echo "$merge" | cut -f 3- -d '/'` - remote="$user-$repo" - git remote add "$remote" "https://github.com/$user/$repo.git" - git fetch "$remote" "$branch" - git merge "$remote/$branch" - git remote remove "$remote" - git status - done - cd .. - cp -a zmk zmk.merged - - name: Cache zephyr + user=`echo "$zmk" | cut -f 1 -d '/'` + repo=`echo "$zmk" | cut -f 2 -d '/'` + branch=`echo "$zmk" | cut -f 3- -d '/'` + git clone -b "$branch" --depth 1 "https://github.com/$user/$repo.git" 'zmk' + + if [ -n "$merges" ] + then + cd "${GITHUB_WORKSPACE}/zmk" + git config user.name "${GITHUB_ACTOR}" + git config user.email "${GITHUB_ACTOR}@users.noreply.github.com" + git fetch --unshallow + for merge in "$merges" + do + user=`echo "$merge" | cut -f 1 -d '/'` + repo=`echo "$merge" | cut -f 2 -d '/'` + branch=`echo "$merge" | cut -f 3- -d '/'` + remote="$user-$repo" + git remote add "$remote" "https://github.com/$user/$repo.git" + git fetch "$remote" "$branch" + git merge "$remote/$branch" + git remote remove "$remote" + git status + done + fi + - name: cache if: true uses: actions/cache@v3 with: path: | - modules/ - tools/ - zephyr/ + zmk/modules/ + zmk/zephyr/ key: zephyr ${{ runner.os }} ${{ hashFiles('zmk/app/west.yml') }} timeout-minutes: 2 continue-on-error: true - - name: West update - run: west update - - name: Restore merge - if: ${{ steps.variables.outputs.merge != '' }} + - name: build run: | - mv zmk zmk.default - mv zmk.merged zmk - - name: Export Zephyr CMake package - run: west zephyr-export - - name: Build - run: west build -s zmk/app -b ${{ matrix.board }} -- ${{ steps.variables.outputs.shield-arg }} -DZMK_CONFIG="${GITHUB_WORKSPACE}/config" - - name: Prepare firmware artifacts - run: | - for extension in "hex" "uf2" + cd "${GITHUB_WORKSPACE}/zmk" + west init -l app + west update + west zephyr-export + + cd "${GITHUB_WORKSPACE}/zmk/app" + west build -b ${{ matrix.board }} -- ${{ steps.variables.outputs.shield-arg }} -DZMK_CONFIG="${GITHUB_WORKSPACE}/miryoku_zmk/config" + + for extension in "uf2" do - file="build/zephyr/zmk.$extension" + file="${GITHUB_WORKSPACE}/zmk/app/build/zephyr/zmk.$extension" if [ -f "$file" ] then cp "$file" "${{ steps.variables.outputs.artifact-dir }}/${{ steps.variables.outputs.artifact-build-name }}.$extension" fi done - - name: Archive artifacts - uses: actions/upload-artifact@v2 + - name: upload + uses: actions/upload-artifact@v3 with: name: ${{ steps.variables.outputs.artifact-generic-name }} path: ${{ steps.variables.outputs.artifact-dir }} - continue-on-error: true + diff --git a/.github/workflows/outboards/ahokore.board.outboard b/.github/workflows/outboards/boards/ahokore similarity index 100% rename from .github/workflows/outboards/ahokore.board.outboard rename to .github/workflows/outboards/boards/ahokore diff --git a/.github/workflows/outboards/ble_chiffre.outboard b/.github/workflows/outboards/boards/ble_chiffre similarity index 100% rename from .github/workflows/outboards/ble_chiffre.outboard rename to .github/workflows/outboards/boards/ble_chiffre diff --git a/.github/workflows/outboards/boards/corne-ish_zen b/.github/workflows/outboards/boards/corne-ish_zen new file mode 100644 index 000000000..c1196a99f --- /dev/null +++ b/.github/workflows/outboards/boards/corne-ish_zen @@ -0,0 +1,4 @@ +# Copyright 2022 Manna Harbour +# https://github.com/manna-harbour/miryoku + +zmk=LOWPROKB/zmk/Board-Corne-ish-Zen-dedicated-work-queue diff --git a/.github/workflows/outboards/boards/ferris_rev02 b/.github/workflows/outboards/boards/ferris_rev02 new file mode 100644 index 000000000..42f430adf --- /dev/null +++ b/.github/workflows/outboards/boards/ferris_rev02 @@ -0,0 +1,4 @@ +# Copyright 2022 Manna Harbour +# https://github.com/manna-harbour/miryoku + +zmk=petejohanson/zmk/boards/ferris-02-bling-basics diff --git a/.github/workflows/outboards/one42.outboard b/.github/workflows/outboards/boards/one42 similarity index 100% rename from .github/workflows/outboards/one42.outboard rename to .github/workflows/outboards/boards/one42 diff --git a/.github/workflows/outboards/preonic_rev3.outboard b/.github/workflows/outboards/boards/preonic_rev3 similarity index 100% rename from .github/workflows/outboards/preonic_rev3.outboard rename to .github/workflows/outboards/boards/preonic_rev3 diff --git a/.github/workflows/outboards/boards/sparkfun_nrf52840_mini b/.github/workflows/outboards/boards/sparkfun_nrf52840_mini new file mode 100644 index 000000000..245a1ac8f --- /dev/null +++ b/.github/workflows/outboards/boards/sparkfun_nrf52840_mini @@ -0,0 +1,9 @@ +# Copyright 2022 Manna Harbour +# https://github.com/manna-harbour/miryoku + +# use with shield microdox_mod + +outboard_repository=abondis/zmk-config +outboard_ref=main +outboard_from=config/boards/arm/sparkfun_nrf52840_mini +outboard_to=boards/arm/sparkfun_nrf52840_mini diff --git a/.github/workflows/outboards/technikable.outboard b/.github/workflows/outboards/boards/technikable similarity index 100% rename from .github/workflows/outboards/technikable.outboard rename to .github/workflows/outboards/boards/technikable diff --git a/.github/workflows/outboards/zaphod.outboard b/.github/workflows/outboards/boards/zaphod similarity index 74% rename from .github/workflows/outboards/zaphod.outboard rename to .github/workflows/outboards/boards/zaphod index 5acb78c38..cf853ccb6 100644 --- a/.github/workflows/outboards/zaphod.outboard +++ b/.github/workflows/outboards/boards/zaphod @@ -1,8 +1,7 @@ -# Copyright 2021 Manna Harbour +# Copyright 2022 Manna Harbour # https://github.com/manna-harbour/miryoku outboard_repository=petejohanson/zaphod-config outboard_ref=main outboard_from=boards/arm/zaphod outboard_to=boards/arm/zaphod -outboard_manifest=west.yml diff --git a/.github/workflows/outboards/corne-ish_zen.outboard b/.github/workflows/outboards/corne-ish_zen.outboard deleted file mode 100644 index 78cdf5603..000000000 --- a/.github/workflows/outboards/corne-ish_zen.outboard +++ /dev/null @@ -1,5 +0,0 @@ -# Copyright 2021 Manna Harbour -# https://github.com/manna-harbour/miryoku - -outboard_url_base=https://github.com/LOWPROKB -outboard_revision=Board-Corne-ish-Zen-dedicated-work-queue diff --git a/.github/workflows/outboards/ferris_rev02.outboard b/.github/workflows/outboards/ferris_rev02.outboard deleted file mode 100644 index 7b5668d76..000000000 --- a/.github/workflows/outboards/ferris_rev02.outboard +++ /dev/null @@ -1,5 +0,0 @@ -# Copyright 2021 Manna Harbour -# https://github.com/manna-harbour/miryoku - -outboard_url_base=https://github.com/petejohanson -outboard_revision=boards/ferris-02-bling-basics diff --git a/.github/workflows/outboards/microdox_mod.outboard b/.github/workflows/outboards/microdox_mod.outboard deleted file mode 100644 index 9043f209f..000000000 --- a/.github/workflows/outboards/microdox_mod.outboard +++ /dev/null @@ -1,9 +0,0 @@ -# Copyright 2021 Manna Harbour -# https://github.com/manna-harbour/miryoku - -# use with included board sparkfun_nrf52840_mini - -outboard_repository=abondis/zmk-config -outboard_ref=main -outboard_from=config/boards -outboard_to=boards diff --git a/.github/workflows/outboards/absolem.outboard b/.github/workflows/outboards/shields/absolem similarity index 100% rename from .github/workflows/outboards/absolem.outboard rename to .github/workflows/outboards/shields/absolem diff --git a/.github/workflows/outboards/ahokore.shield.outboard b/.github/workflows/outboards/shields/ahokore similarity index 100% rename from .github/workflows/outboards/ahokore.shield.outboard rename to .github/workflows/outboards/shields/ahokore diff --git a/.github/workflows/outboards/arch36.outboard b/.github/workflows/outboards/shields/arch36 similarity index 100% rename from .github/workflows/outboards/arch36.outboard rename to .github/workflows/outboards/shields/arch36 diff --git a/.github/workflows/outboards/bastyl.outboard b/.github/workflows/outboards/shields/bastyl similarity index 100% rename from .github/workflows/outboards/bastyl.outboard rename to .github/workflows/outboards/shields/bastyl diff --git a/.github/workflows/outboards/bat43.outboard b/.github/workflows/outboards/shields/bat43 similarity index 100% rename from .github/workflows/outboards/bat43.outboard rename to .github/workflows/outboards/shields/bat43 diff --git a/.github/workflows/outboards/berylline.outboard b/.github/workflows/outboards/shields/berylline similarity index 100% rename from .github/workflows/outboards/berylline.outboard rename to .github/workflows/outboards/shields/berylline diff --git a/.github/workflows/outboards/boardsource5x12.outboard b/.github/workflows/outboards/shields/boardsource5x12 similarity index 100% rename from .github/workflows/outboards/boardsource5x12.outboard rename to .github/workflows/outboards/shields/boardsource5x12 diff --git a/.github/workflows/outboards/chocv.outboard b/.github/workflows/outboards/shields/chocv similarity index 100% rename from .github/workflows/outboards/chocv.outboard rename to .github/workflows/outboards/shields/chocv diff --git a/.github/workflows/outboards/contra.outboard b/.github/workflows/outboards/shields/contra similarity index 100% rename from .github/workflows/outboards/contra.outboard rename to .github/workflows/outboards/shields/contra diff --git a/.github/workflows/outboards/draculad.outboard b/.github/workflows/outboards/shields/draculad similarity index 100% rename from .github/workflows/outboards/draculad.outboard rename to .github/workflows/outboards/shields/draculad diff --git a/.github/workflows/outboards/ergodash.outboard b/.github/workflows/outboards/shields/ergodash similarity index 100% rename from .github/workflows/outboards/ergodash.outboard rename to .github/workflows/outboards/shields/ergodash diff --git a/.github/workflows/outboards/ergotravel.outboard b/.github/workflows/outboards/shields/ergotravel similarity index 100% rename from .github/workflows/outboards/ergotravel.outboard rename to .github/workflows/outboards/shields/ergotravel diff --git a/.github/workflows/outboards/gatoraid40.outboard b/.github/workflows/outboards/shields/gatoraid40 similarity index 100% rename from .github/workflows/outboards/gatoraid40.outboard rename to .github/workflows/outboards/shields/gatoraid40 diff --git a/.github/workflows/outboards/hillside.outboard b/.github/workflows/outboards/shields/hillside similarity index 100% rename from .github/workflows/outboards/hillside.outboard rename to .github/workflows/outboards/shields/hillside diff --git a/.github/workflows/outboards/horizon.outboard b/.github/workflows/outboards/shields/horizon similarity index 100% rename from .github/workflows/outboards/horizon.outboard rename to .github/workflows/outboards/shields/horizon diff --git a/.github/workflows/outboards/hummingbird.outboard b/.github/workflows/outboards/shields/hummingbird similarity index 100% rename from .github/workflows/outboards/hummingbird.outboard rename to .github/workflows/outboards/shields/hummingbird diff --git a/.github/workflows/outboards/levinson.outboard b/.github/workflows/outboards/shields/levinson similarity index 100% rename from .github/workflows/outboards/levinson.outboard rename to .github/workflows/outboards/shields/levinson diff --git a/.github/workflows/outboards/shields/microdox_mod b/.github/workflows/outboards/shields/microdox_mod new file mode 100644 index 000000000..3e6b9fe34 --- /dev/null +++ b/.github/workflows/outboards/shields/microdox_mod @@ -0,0 +1,9 @@ +# Copyright 2022 Manna Harbour +# https://github.com/manna-harbour/miryoku + +# use with board sparkfun_nrf52840_mini + +outboard_repository=abondis/zmk-config +outboard_ref=main +outboard_from=config/boards/shields/microdox_mod +outboard_to=boards/shields/microdox_mod diff --git a/.github/workflows/outboards/pockettype.outboard b/.github/workflows/outboards/shields/pockettype similarity index 100% rename from .github/workflows/outboards/pockettype.outboard rename to .github/workflows/outboards/shields/pockettype diff --git a/.github/workflows/outboards/pteron36.outboard b/.github/workflows/outboards/shields/pteron36 similarity index 100% rename from .github/workflows/outboards/pteron36.outboard rename to .github/workflows/outboards/shields/pteron36 diff --git a/.github/workflows/outboards/rebound_v4.outboard b/.github/workflows/outboards/shields/rebound_v4 similarity index 100% rename from .github/workflows/outboards/rebound_v4.outboard rename to .github/workflows/outboards/shields/rebound_v4 diff --git a/.github/workflows/outboards/reviung39.outboard b/.github/workflows/outboards/shields/reviung39 similarity index 100% rename from .github/workflows/outboards/reviung39.outboard rename to .github/workflows/outboards/shields/reviung39 diff --git a/.github/workflows/outboards/scylla_dmmpcb.outboard b/.github/workflows/outboards/shields/scylla_dmmpcb similarity index 100% rename from .github/workflows/outboards/scylla_dmmpcb.outboard rename to .github/workflows/outboards/shields/scylla_dmmpcb diff --git a/.github/workflows/outboards/sofle_rgb.outboard b/.github/workflows/outboards/shields/sofle_rgb similarity index 100% rename from .github/workflows/outboards/sofle_rgb.outboard rename to .github/workflows/outboards/shields/sofle_rgb diff --git a/.github/workflows/outboards/tbkmini.outboard b/.github/workflows/outboards/shields/tbkmini similarity index 100% rename from .github/workflows/outboards/tbkmini.outboard rename to .github/workflows/outboards/shields/tbkmini diff --git a/.github/workflows/outboards/tightyl.outboard b/.github/workflows/outboards/shields/tightyl similarity index 100% rename from .github/workflows/outboards/tightyl.outboard rename to .github/workflows/outboards/shields/tightyl diff --git a/.github/workflows/outboards/viterbi.outboard b/.github/workflows/outboards/shields/viterbi similarity index 100% rename from .github/workflows/outboards/viterbi.outboard rename to .github/workflows/outboards/shields/viterbi diff --git a/.github/workflows/outboards/zaphod_lite.outboard b/.github/workflows/outboards/shields/zaphod_lite similarity index 100% rename from .github/workflows/outboards/zaphod_lite.outboard rename to .github/workflows/outboards/shields/zaphod_lite diff --git a/.github/workflows/zmk b/.github/workflows/zmk new file mode 100644 index 000000000..c4d8765a9 --- /dev/null +++ b/.github/workflows/zmk @@ -0,0 +1,4 @@ +# Copyright 2022 Manna Harbour +# https://github.com/manna-harbour/miryoku + +zmk=zmkfirmware/zmk/main diff --git a/config/west.yml b/config/west.yml deleted file mode 100644 index 379d29193..000000000 --- a/config/west.yml +++ /dev/null @@ -1,11 +0,0 @@ -manifest: - remotes: - - name: zmkfirmware - url-base: https://github.com/zmkfirmware - projects: - - name: zmk - remote: zmkfirmware - revision: main - import: app/west.yml - self: - path: config diff --git a/readme.org b/readme.org index e7c64e7e7..47b7012e0 100644 --- a/readme.org +++ b/readme.org @@ -148,15 +148,15 @@ Appends to the [[#config-file][config]] file. Join multiple lines with ~\n~. F Appends to [[#kconfig-configuration][Kconfig configuration]]. Join multiple lines with ~\n~. For no additonal config, leave as ~default~. -****** ZMK Branches / merge +****** ZMK Branches / branches Used to select an alternative ZMK branch for building, and to merge branches into ZMK at build time. -An alternative ZMK branch for building is specified as ~=//~, i.e. with a leading ~=~. E.g. the default ZMK branch would be specified as ~=zmkfirmware/zmk/main~. +Branches are specified in the form ~//~. E.g. the default ZMK branch would be specified as ~zmkfirmware/zmk/main~. -Branches for merging are specified as ~//~, i.e. with no leading ~=~. E.g. the default ZMK branch would be specified as ~zmkfirmware/zmk/main~. +Multiple space separated branches can be specified. The first branch specified is used as an alternative ZMK branch for building. Any additional branches will be merged. -To specify multiple branches, separate with space. For no changes, leave as ~default~. +For no changes, leave as ~default~. ** Supported Keyboards @@ -350,13 +350,13 @@ Add ~#define MIRYOKU_KLUDEGE_MOUSEKEYSPR~ to the [[#config-file][config file]]. Add ~CONFIG_ZMK_MOUSE=y~ to the [[#kconfig-configuration][Kconfig configuration]]. -[[#zmk-branches--merge][Merge or build]] from the mousekeys PR branch ~krikun98/zmk/mouse-pr~ +[[#zmk-branches--branches][Merge or build]] from the mousekeys PR branch ~krikun98/zmk/mouse-pr~ -For [[#workflow-builds][workflow builds]], the [[#build-inputs][Build Inputs]] workflow can be used, or for [[#build-examples][Build Examlpe]] workflows see the [[./github/workflows/build-example-corne-nice_nano-mousekeyspr.yml][Build Example corne nice_nano mousekeyspr]] workflow. +For [[#workflow-builds][workflow builds]], the [[#build-inputs][Build Inputs]] workflow can be used, or for [[#build-examples][Build Examlpe]] workflows see the [[./github/workflows/build-example-mousekeyspr.yml][Build Example mousekeyspr]] workflow. For local builds, make the changes to the local files. -If the PR hasn't been rebased recently the automatic merge may fail. In that case merge manually or build directly from the branch. +If the PR hasn't been rebased recently the automatic merge may fail. In that case build directly from the branch or merge manually. *** Key Emulation Combos