Skip to content

docs: readme improvements #256

docs: readme improvements

docs: readme improvements #256

Workflow file for this run

# Simple workflow for drawing the keymap and deploying static content to GitHub Pages
name: Draw keymap
on:
workflow_dispatch: # can be triggered manually
push:
paths:
- "config/corneish_zen.keymap"
- "config/*.dtsi"
- "knucklehead/*.dtsi"
- "keymap-drawer/config.yaml"
- ".github/workflows/draw.yml"
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
draw:
uses: caksoylar/keymap-drawer/.github/workflows/draw-zmk.yml@main
permissions:
contents: write
with:
install_branch: "main" # branch to install keymap-drawer from
keymap_patterns: "config/corneish_zen.keymap" # path to the keymaps to parse
config_path: "keymap-drawer/config.yaml" # config file, ignored if it doesn't exist
output_folder: "keymap-drawer" # path to save produced SVGs
# commit_message: "Draw: ${{ github.event.head_commit.message }}"
amend_commit: true # whether to amend the commit or create a new one
fail_on_error: true