Skip to content
anchor

GitHub Action

QMK Keyboard firmware build

v1 Latest version

QMK Keyboard firmware build

anchor

QMK Keyboard firmware build

Build QMK firmware using github actions

Installation

Copy and paste the following snippet into your .yml file.

              

- name: QMK Keyboard firmware build

uses: justgook/qmk-build@v1

Learn more about this action in justgook/qmk-build

Choose a version

QMK firmware build action

This action builds firmware for custom keymap in github actions runners No more need to download and setup QMK environment on local machine - just use power of Github Actions to build your keyboard firmware.

Inputs

  • keymap-path - Path to Your keymap folder, must be same as qmk_firmware path ("keyboards/idobao/id75/keymaps/justgook")
  • keyboard - Keyboard name ("idobao/id75/v1")
  • keymap: "Keymap name, must match keymap-path folder" ("justgook")

Example usage

    steps:

      - uses: actions/checkout@v1

      - name: Build Firmware
        uses: ./
        with:
          keymap-path: "keyboards/idobao/id75/keymaps/justgook"
          keyboard: "idobao/id75/v1"
          keymap: "justgook"

      - name: Upload a Firmware
        uses: actions/upload-artifact@v3.1.2
        with:
          name: firmware
          path: build