https://github.com/d3adb5/build-qmk-fw

Build your QMK firmware from source by pointing to your keymap of choice.
https://github.com/d3adb5/build-qmk-fw

github-actions github-actions-docker qmk-firmware

Last synced: 5 months ago
JSON representation

Build your QMK firmware from source by pointing to your keymap of choice.

• Host: GitHub
• URL: https://github.com/d3adb5/build-qmk-fw
• Owner: d3adb5
• Created: 2023-12-31T08:07:02.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-29T04:46:34.000Z (about 2 years ago)
• Last Synced: 2024-04-29T05:36:15.814Z (about 2 years ago)
• Topics: github-actions, github-actions-docker, qmk-firmware
• Language: C
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Build QMK Firmware

Build QMK firmware for your keyboard using your keymap with GitHub Actions.

## Options

| Input               | Description                                                    | Required | Default      |

|:--------------------|:---------------------------------------------------------------|:---------|:-------------|

| `keyboard`          | The target keyboard for this firmware build                    | Yes      |              |

| `keymap`            | The keymap to build for this firmware                          | Yes      | `default`    |

| `controller`        | The controller to build for this firmware                      | No       |              |

| `local-keymap-path` | Path to a local keymap directory to inject into the QMK home   | No       | ` `          |

| `output-dir`        | Directory in the workspace where built firmware will be placed | No       | `qmk-output` |

The `output-dir` input is the directory in your GitHub Actions workflow's

workspace where the built firmware images will be placed. The `built-images`

output will be set to a comma-separated list of files placed in that directory.

## Example

```yaml

name: Build my QMK configuration

on:

  push:

    branches:

      - master

  pull_request: {}

jobs:

  build-qmk:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: d3adb5/build-qmk-fw@v1

        with:

          keyboard: dztech/dz65rgb/v3

          keymap: my-keymap

          controller: helios

          local-keymap-path: keymaps/my-keymap

          output-dir: qmk-firmware-to-be-flashed

      - uses: actions/upload-artifact@v4

        with:

          name: built-images

          path: qmk-firmware-to-be-flashed

```