Building QMK with GitHub Userspace

This is an intermediate QMK tutorial to setup an out-of-tree build environment with a personal GitHub repository. It avoids using a fork of the QMK firmware to store and build your keymap within its source tree. Keymap files will instead be stored in your own personal GitHub repository, in Userspace format, and built with an action workflow. Unlike the default tutorial, this guide requires some familiarity with using Git.

Is This Guide For Me?

This is a lean setup to avoid space-consuming local build environment in your computer. Troubleshooting compile-time errors will be slower with commit uploads to GitHub for the compiler workflow.

Prerequisites

The following are required to get started:

• GitHub Account
  • A working account is required to setup and host your repository for GitHub Actions to build QMK firmware.
• Text editor
  • You’ll need a program that can edit and save plain text files. The default editor that comes with many OS's does not save plain text files, so you'll need to make sure that whatever editor you chose does.
• Toolbox
  • A graphical program for Windows and macOS that allows you to both program and debug your custom keyboard.

Environment Setup

TIP

If you are familiar with using github.dev, you can skip to step 2 and commit the code files that follows directly on GitHub using the web-based VSCode editor.

1. Install Git

A working Git client is required for your local operating system to commit and push changes to GitHub.

QMK maintains a bundle of MSYS2, the CLI and all necessary dependencies including Git. Install QMK MSYS with the latest release here. Git will be part of the bundle.

2. GitHub authentication

If your GitHub account is not configured for authenticated Git operations, you will need to setup at least one of the following:

• Personal access token
• Connecting with SSH

3. Create a repository

You will need a personal GitHub repository to host your QMK code. Follow this guide to create one named qmk_keymap. Do not proceed to commit any files just yet.

Initial Code Commit

Create template files

Run the following commands in your computer to create a folder with a few template files:

mkdir -p ~/qmk_keymap/.github/workflows
touch ~/qmk_keymap/.github/workflows/build.yml
touch ~/qmk_keymap/config.h
echo "SRC += source.c" > ~/qmk_keymap/rules.mk
echo "#include QMK_KEYBOARD_H" > ~/qmk_keymap/source.c

TIP

For Windows user running MSYS, those commands will create the folder qmk_keymap/ and its content in the C:\Users\<windows_username>\qmk_keymap\ path location.

Add a JSON keymap

Visit the QMK Configurator to create a keymap file:

1. Select your keyboard from the drop-down list (and choose a layout if required).
2. Use your GitHub username for the Keymap Name field.
3. Customise the key layout according to your preference.
4. Select download next to KEYMAP.JSON and save the JSON file into the ~/qmk_keymap/ folder.

WARNING

Important: Make sure that the GitHub username you use in step 2 is correct. If it is not, the build process will fail to locate your files in the right folder.

Add a GitHub Action workflow

Open the file ~/qmk_keymap/.github/workflows/build.yml with your favorite text editor, paste the following workflow content, and save it:

name: Build QMK firmware
on: [push, workflow_dispatch]

jobs:
  build:
    runs-on: ubuntu-latest
    container: ghcr.io/qmk/qmk_cli
    strategy:
      fail-fast: false
      matrix:
# List of keymap json files to build
        file:
        - username.json
# End of json file list

    steps:

    - name: Disable git safe directory checks
      run : git config --global --add safe.directory '*'

    - name: Checkout QMK
      uses: actions/checkout@v3
      with:
        repository: qmk/qmk_firmware
        submodules: recursive

    - name: Checkout userspace
      uses: actions/checkout@v3
      with:
        path: users/${{ github.actor }}

    - name: Build firmware
      run: qmk compile "users/${{ github.actor }}/${{ matrix.file }}"

    - name: Archive firmware
      uses: actions/upload-artifact@v3
      continue-on-error: true
      with:
        name: ${{ matrix.file }}_${{ github.actor }}
        path: |
          *.hex
          *.bin
          *.uf2

Replace username.json with the JSON file name that was downloaded from QMK Configurator in the previous step.

WARNING

Do note that the build.yml file requires proper indentation for every line. Incorrect spacing will trigger workflow syntax errors.

Commit files to GitHub

If you have completed all steps correctly, the folder qmk_keymap/ will contain the following files:

├── .github
│   └── workflows
│       └── build.yml
├── rules.mk
├── config.h
├── source.c
└── username.json

To commit and push them into GitHub, run the following commands (replacing gh-username with your GitHub user name):

cd ~/qmk_keymap
git init
git add -A
git commit -m "Initial QMK keymap commit"
git branch -M main
git remote add origin https://github.com/gh-username/qmk_keymap.git
git push -u origin main

TIP

Use your GitHub personal access token at the password prompt. If you have setup SSH access, replace https://github.com/gh-username/qmk_keymap.git with git@github.com:gh-username/qmk_keymap.git in the remote origin command above.

Review workflow output

Files committed to GitHub in the previous step will automatically trigger the workflow to build the JSON file listed in build.yml. To review its output:

1. Visit your "qmk_keymap" repository page on GitHub.
2. Select Actions tab to display the "Build QMK Firmware" workflow.
3. Select that workflow to display its run from the last commit.
4. Successfully compiled firmware will be under the "Artifacts" section.
5. If there are build errors, review the job log for details.

Download and flash the firmware file into your keyboard using QMK Toolbox.

Customising your keymap

This setup and workflow relies on the QMK Userspace feature. The build process will copy the QMK source codes and clone your repository into its users/ folder in a container. You must adhere to the following guidelines when customising your keymaps:

• Keymap layout files must be retained in JSON format and cannot be converted to keymap.c.
• User callback and functions (e.g. process_record_user()) can be placed in the source.c file.
• Multiple keymap JSON files can be built in the same workflow. List them under matrix.file:, e.g.:

        file:
        - planck.json
        - crkbd.json

• Code changes will require Git commit into GitHub to trigger the build workflow.

TIP

See GitHub Actions guide to learn more about development workflow.