chore: release v0.4.0

[conventoangelo]

🤖 New release prepared

0.4.0 (2026-02-21)

⚠ BREAKING CHANGES

• add support for user-defined keyboard layers (#114)

✨ Features

• add status overlay for keyboard visibility (a520b95)
• add animations on key press (#66) (74bb7cf)
• add animations settings in preferences window (74bb7cf)
• add custom shift mappings in overkeys_config.json (1cf6506)
• add drop shadow to keys (#104) (7d5fc4c)
• add ESC key tip in preferences window (b22db49)
• add half increments to marker height (2bca469)
• add hide on default layer functionality (#141) (55cb207)
• add hotkeys for increasing/decreasing opacity (#98) (b5d7e65)
• add hotkeys for toggling move and opening preferences (536608d)
• add hotkeys to tray menu label (48c8bc6)
• add ignored keys functionality to prevent overlay triggering (135edb3)
• add key borders to improve key visibility (#72) (6adfd6a)
• add keyboard follows mouse functionality (#73) (ce6644c)
• add lastRowSplitWidth settings for split matrix (85ed250)
• add learning mode (overrides colors settings) (#79) (3989ea1)
• add more fonts to options (836c230)
• add note for thumb key/s learning mode color customization (fd1fb8e)
• add option for enabling or disabling reactive shift (#135) (3369a9e)
• add option to make OverKeys hidden on startup (#137) (320f26e)
• add overkeys custom learn_mode picture by @MG240 (#88) (ae3f554)
• add reload config option to tray menu (#99) (48c8bc6)
• add status overlay for auto-hide (a520b95)
• add status overlay for move (a520b95)
• add status overlay for reset position (a520b95)
• add status overlays for tray menu toggles and hotkeys (#65) (a520b95)
• add support for 6 column split keyboard layouts (#61) (85ed250)
• add support for 6 column split keyboards (85ed250)
• add support for additional key codes (#151) (1935ff1)
• add support for custom aliases (#150) (ca4f1ad)
• add support for custom fonts (#71) (836c230)
• add support for custom keys in split matrix last row (85ed250)
• add support for F13-F24 keys (1ddf917)
• add support for reactive shifted keys (#94) (1cf6506)
• add support for user-defined keyboard layers (#114) (1ddf917)
• add window listener to try fixing focus behavior (061485f)
• added greek, russian, and arabic (language) layouts (63b369e)
• added support for recognizing keypress states of foreign layouts(#122) (63b369e)
• disable/enable specific hotkeys (#95) (b22db49)
• implement locales through customKeys in user config (#139) (a5bc6da)
• improve preferences window UI (9da0734)
• improve preferences window UI (#60) (9da0734)
• numpad keys now share state with regular keys (#118) (0d2856f)
• refactor and add more tabs to preferences (9da0734)
• restore focus to last active window on tray icon click (6a469e6)
• show initial hotkey on hotkey recorder dialog open (536608d)
• update about tab to include current year and support (#157) (5febaf4)
• use ESC to close preferences window (66ad129)
• use lucide icons (9da0734)

🐛 Bug Fixes

• add debounce timer for opacity hotkey to remove visual lag (#112) (9df40b7)
• add ذ to Arabic keyboard layout (#171) (2c60ed3)
• adjust key index handling for 6-column layout (#110) (9ccffd5)
• advanced settings changes reflected without restarting (#78) (536608d)
• animate tactile markers together with key (f2240be)
• apply learning mode color to grave key (70060e0)
• auto-hide in prefs window now updates even when closed (061485f)
• change blur style to normal (3acd87c)
• close preferences before exiting application (e1b7074)
• close preferences window on escape key press (e2c9224)
• color picker now uses hex rgb format (6e04243)
• correct icons for move enabled/disabled status overlays (3989ea1)
• disabled color picker copy/paste buttons and shortcuts causing errors (6e04243)
• focus previously opened preferences window on hotkey trigger (314b0b6)
• force hide on tray icon click (061485f)
• force single-instance of app (061485f)
• force single-instance of preferences window (061485f)
• improve auto-hide on non-default keyboard layers (#158) (df734da)
• improve force hide logic to not conflict with auto-hide (a520b95)
• keyboard now remains hidden when auto-hide disabled (0563c7c)
• load user layers when use user layout is toggled (6c34925)
• make modifiers default to left modifiers for now (85ed250)
• only listen to layer changes if useUserLayout is true (1ddf917)
• only shrink keys longer than length 2 (#77) (3f5dfab)
• opacity hotkeys now only works when keyboard is visible (56b2a7d)
• reload config every connect to kanata call (48c8bc6)
• retest/revert advanced settings functionality after refactor (#149) (c860aad)
• revert to correct font family after reloading config and turning custom font off (48c8bc6)
• revert to the defaultUserLayout after layer changes (1ddf917)
• set defaultUserLayout when using kanata (216eb8a)
• split matrix errors due to changing space width (bfdc418)
• streamline key index adjustment for 6-column layout (#136) (39d94eb)
• tray menu now disappears when clicking anywhere after menu pops up (061485f)
• tray menu, window logic, and UI fixes (#57) (061485f)
• update alias mappings to reflect numpad keys behavior change (0d2856f)
• update auto-hide behavior based on user layout (non-kanata) (186362a)
• update color picker behavior (#93) (6e04243)
• update font weight handling to use value instead of index (6a69143)
• use LucideIcons for open config button (536608d)

📚 Documentation

• add 6-column split matrix sample layout (2f84394)
• add custom font feature documentation (f3ea673)
• add custom shift mapping documentation (6c84692)
• add documentation for custom layouts and locales support (4e11fa9)
• add key border and drop shadow settings (8981dfd)
• add keyboard shortcuts for increasing and decreasing opacity (1d7306f)
• add locales feature in README.md (728a4da)
• add missing context menu options for Hide/Show and Reload Config (fe2e68f)
• add more topic specific docs (615d5e0)
• add note about thumb keys color setting in Learning Mode (051bade)
• add note on configuring key combos for layer changes (d832165)
• add sample config file (ba4e765)
• add user-defined layers feature (006334b)
• update and refine documentation (c832d7a)
• update configuration instructions to use 'Reload config' instead of restarting OverKeys (2c29063)
• update docs to reflect numpad keys behavior change (0d2856f)
• update documentation for Learning Mode (5a8f8bc)
• update locales documentation with French AZERTY key mappings (dd8b19f)
• update option label from "Use custom layout from config" to "Use user layouts" (1ddf917)
• update supported function keys range from F1-F12 to F1-F24 (a239190)
• update tab references from General to Advanced in setup instructions (6c02e74)
• update workflow references and formatting in documentation (79c7849)
• updates instructions for finding config file (#132) (cadc011)
• upload overkeys_cover.png (605afa9)
• use same wording as in preferences window in its documentation (52d53de)

⚙️ CI/CD Pipeline

• add bootstrap-sha to release-please (314dee5)
• add changelog fetching from release-please PR for nightly builds (10bb352)
• add manual test build workflow with version input for Windows (df48884)
• add manual workflow dispatch for testing of nightly-build (cd27a1b)
• add release pipeline workflow for building and testing Windows installers (29fa820)
• add verification for build output existence in Windows build script (cef21b7)
• correct folder path for compression (f629fbe)
• correct label name from 'approved-for-release' to 'approve-for-release' in release approval workflow (a245b83)
• correct powershell escape error (2775417)
• correcting trigger on release-please PR without checking author (bf7a7f6)
• enhance release approval workflow with additional diagnostics and synchronization support (6c54607)
• fix changelog fetching and parsing (8f24e70)
• improve changelog handling by using EOF delimiter for multiline content (f0546e9)
• improve ZIP integrity verification in release pipeline (9726946)
• remove debug output for changelog extraction in nightly build (7f8bcde)
• remove installer integrity tests from nightly and release pipelines (3960e52)
• revamp cicd with nightly builds and approval gates (8927470)
• show hidden changelog sections (cc6ee26)
• update author for fetching release-please PR changelog (fb44c27)
• update nightly build to run once per midnight (c1d5030)
• update nightly build versioning and installer output to reflect CI version (e56ea8d)
• update permissions in build-release.yml and improve comment clarity in build_windows.ps1 (97e3824)
• update release-please workflow to use RELEASE_PLEASE_TOKEN for triggering workflows (7ce7a56)

🔨 Refactoring

• add null checks in UserConfig serialization (0d28498)
• clean config file by not saving null fields (a5bc6da)
• consolidate hotkey retrieval logic into a single method (78b75f3)
• correct variable naming of userLayout/s (48c8bc6)
• enhance shifted symbol mapping using activeKeyCodeShiftMap (a5bc6da)
• improve code health (#111) (78b75f3)
• make customShiftMappings nullable in UserConfig (a5bc6da)
• modularize preference loading into separate methods (78b75f3)
• move font_options to a separate file (836c230)
• move variables to more appropriate groups (1ddf917)
• rename to advancedSettingsEnabled for consistency (836c230)
• simplify key retrieval logic in getKeyFromKeyCodeShift function (78b75f3)
• update toggle option label and subtitle for user layout (1ddf917)
• update user config handling and remove default values (345f777)
• use riverpod for state management (#147) (f800916)

---

This PR was generated with Release Please. See documentation.

Summary by CodeRabbit

Release 0.4.0 Now Available

• Breaking Changes

  • Notable breaking changes introduced in this version.

• New Features

  • Multiple new features and UI improvements added.

• Bug Fixes

  • Various bug fixes and performance enhancements.

• Documentation

  • Documentation updates and localization support.

• Refactoring

  • Code refactoring improvements implemented.

• CI/CD Pipeline

  • CI workflow enhancements.

[github-actions]

🚀 Release Approval Workflow

Step 1: Verify Release Content ✅

• Review the changelog and version bump
• Ensure all changes are intended
• Check that automated installer tests passed (see build artifacts)

Step 2: Approve for Publishing

When you're ready to publish this release:

1. Add the approve-for-release label to this PR (or react with ✅)
2. A workflow will:
   • Merge this PR automatically
   • Create a GitHub Release (draft → published)
   • Publish to Windows Package Manager (winget)

Step 3: Monitor Publishing

Once merged, check Actions for:

• release-pipeline: Uploads installers to release
• winget-releaser: Publishes to Windows Package Manager (~5 min delay)

---

Release: v0.4.0 | PR: #173

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request bumps the application version from 0.3.4 to 0.4.0 across configuration and manifest files, and adds a comprehensive changelog entry documenting the new release's features, improvements, and fixes.

Changes

Cohort / File(s)	Summary
Version Manifest Updates .release-please-manifest.json, pubspec.yaml, scripts/compile_exe-inno.iss	Version bumped from 0.3.4 to 0.4.0 across release manifest, package configuration, and Inno Setup installer script.
Release Documentation CHANGELOG.md	New 0.4.0 release entry added with sections for breaking changes, features, bug fixes, documentation improvements, CI/CD pipeline enhancements, and refactoring notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A version bump hops into place,
From 0.3.4's old race,
To 0.4.0, shiny and new,
With features and fixes so true,
The changelog tells every tale,
Our release will surely not fail! 🚀

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title 'chore: release v0.4.0' directly and clearly summarizes the main change—a version release bump. It accurately reflects the changeset which updates versions across multiple files (manifest, pubspec.yaml, changelog, and Inno setup script) and adds comprehensive release documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch release-please--branches--main--components--overkeys

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CHANGELOG.md`:
- Line 12: Fix the double space in the changelog entry by editing the line
containing "add  status overlay ([a520b95]...)" and replace the token "add 
status" with "add status" so the entry reads "add status overlay (...)".
- Around line 3-179: The 0.4.0 changelog wrongly aggregates commits already
included in 0.3.x due to a Release Please baseline issue; verify and correct the
release-please bootstrap-sha (and any baseline/tag settings) in your
release-please configuration, then regenerate the changelog so 0.4.0 only
contains commits since the latest released tag (or manually prune duplicate
commits from the 0.4.0 section if regeneration is not possible), ensuring the
commit hashes like 1ddf917 and 1935ff1 appear only under their original
releases.
- Around line 52-53: Remove the duplicate "improve preferences window UI" entry
in CHANGELOG.md by keeping the line that includes the issue reference (the entry
referencing issue `#60` and commit 9da0734) and deleting the redundant line that
only references commit 9da0734; ensure the remaining entry preserves the issue
link and commit hash formatting.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

0.4.0 changelog aggregates commits already present in previously-released 0.3.x versions.

Many entries in the 0.4.0 section are already present verbatim in earlier patch entries — for example, commit 1ddf917 ("add support for user-defined keyboard layers") appears in both the 0.4.0 block (line 46) and the 0.3.0 block (line 318); commit 1935ff1 ("add support for additional key codes") in 0.4.0 (line 40) and 0.3.3 (line 231); and so on across 0.3.1, 0.3.2, 0.3.3, and 0.3.4. The 0.4.0 section effectively re-lists everything shipped in all prior patch versions, making it hard for users to identify what is genuinely new in this release.

This is consistent with a Release Please bootstrap-sha misconfiguration or an aggregation behavior where the generator collects all unreleased commits since the baseline rather than only commits since the latest tag. The project already tracks changelog-related CI fixes in this very changelog, so this may be a known gap. Consider verifying the bootstrap-sha value in the Release Please configuration and whether the CHANGELOG.md should be manually trimmed before merging to avoid user confusion.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` around lines 3 - 179, The 0.4.0 changelog wrongly aggregates
commits already included in 0.3.x due to a Release Please baseline issue; verify
and correct the release-please bootstrap-sha (and any baseline/tag settings) in
your release-please configuration, then regenerate the changelog so 0.4.0 only
contains commits since the latest released tag (or manually prune duplicate
commits from the 0.4.0 section if regeneration is not possible), ensuring the
commit hashes like 1ddf917 and 1935ff1 appear only under their original
releases.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Minor: extra space in changelog entry.

add status overlay has a double space — add status → add status.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` at line 12, Fix the double space in the changelog entry by
editing the line containing "add  status overlay ([a520b95]...)" and replace the
token "add  status" with "add status" so the entry reads "add status overlay
(...)".

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Duplicate improve preferences window UI entry in the Features section.

Both lines point to the same commit (9da0734) — one includes issue #60, the other does not. Only one entry should be kept (the one with the issue reference is preferred for traceability).

📝 Proposed fix

-* improve preferences window UI ([9da0734](https://github.com/conventoangelo/OverKeys/commit/9da0734189d70b9cf8fe4ad36fb6ac2cf7bb46bf))
 * improve preferences window UI ([`#60`](https://github.com/conventoangelo/OverKeys/issues/60)) ([9da0734](https://github.com/conventoangelo/OverKeys/commit/9da0734189d70b9cf8fe4ad36fb6ac2cf7bb46bf))

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	* improve preferences window UI ([9da0734](https://github.com/conventoangelo/OverKeys/commit/9da0734189d70b9cf8fe4ad36fb6ac2cf7bb46bf))
	* improve preferences window UI ([#60](https://github.com/conventoangelo/OverKeys/issues/60)) ([9da0734](https://github.com/conventoangelo/OverKeys/commit/9da0734189d70b9cf8fe4ad36fb6ac2cf7bb46bf))
	* improve preferences window UI ([`#60`](https://github.com/conventoangelo/OverKeys/issues/60)) ([9da0734](https://github.com/conventoangelo/OverKeys/commit/9da0734189d70b9cf8fe4ad36fb6ac2cf7bb46bf))

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` around lines 52 - 53, Remove the duplicate "improve preferences
window UI" entry in CHANGELOG.md by keeping the line that includes the issue
reference (the entry referencing issue `#60` and commit 9da0734) and deleting the
redundant line that only references commit 9da0734; ensure the remaining entry
preserves the issue link and commit hash formatting.

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[github-actions]

Release Installers Built

Version: v0.4.0
Build Run: #26

📦 Artifacts Created:

• overkeys_0.4.0_x64_setup.exe (InnoSetup Installer)
• overkeys_0.4.0_x64.zip (Portable ZIP)

Retention: Artifacts will be kept for 7 days.

✅ Installers have been built successfully. Download the artifacts above to test manually before merging.