Skip to content

history.md format

Jump to bottom
Darcy Wong edited this page Nov 26, 2020 · 2 revisions

Keyman 14.0 onward

All changes are kept in the HISTORY.md file at the repo's top level folder. The human-readable change log is automatically updated by the nightly build task.

Scopes should conform to the ones in /resources/scopes/scopes.json.

Keyman 13.0 and earlier

Each platform (/android /ios /mac /windows /web /linux) has a history.md file in its top level folder that tracks the human-readable change log for that project.

The log will be automatically parsed by various CI tools and also help.keyman.com, so it must be in a machine-readable structure as well. The structure is as follows - newer versions at top.

# Project Name Version History

## major.minor alpha
* release note (#pull)

## yyyy-mm-dd major.minor.build tier
* release note (#pull)

Example:

# Keyman Desktop Version History

## 2018-04-16 10.0.1091.0 beta
* Fixes Ctrl+Alt simulation regression (#835)

## 2018-05-11 10.0.1090.0 beta
* No changes in Keyman Desktop

## 10.0 alpha
* Keyman Desktop moved to open source (#121)
* Support for custom BCP 47 language codes: you can now associate a keyboard with any valid language code in Windows 8 and later

## 9.0.522 stable
* Keyboard hotkey toggles are not working in 9.0 (I5086)
* Improve compatibility with Firefox 42 and Internet Explorer 11 (I4933)
* Fix hang when closing Keyman if Windows compatibility flag is incorrectly set (I5018)
  1. When we move to beta, we add a new ## major.minor beta section and like
## 2018-03-22 10.0.1054.0 beta
* Initial beta release of Keyman Developer 10

  1. Strict adherence will be enforced by script for anything of version number 10.0 or above, as some of the old history data is incomplete and lost to time.

  2. Where possible, pull request numbers should be referenced with #pull as per the example above, within parentheses. When multiple pull requests are fixing an issue, just separate them with commas.

  3. Newer releases go further up in the file.

  4. Lines without any heading markers (#, ##, ###) or bullet marks (indentation optional) will be ignored by related history.md processing scripts.

Clone this wiki locally