diff --git a/docs/history-and-versioning.md b/docs/history-and-versioning.md index 3b1b936bf4..4e5cafb078 100644 --- a/docs/history-and-versioning.md +++ b/docs/history-and-versioning.md @@ -1,48 +1,48 @@ # History and Versioning -In Keyman 14.0, history and versioning is controlled as part of the build process, +In Keyman 14.0, history and versioning is controlled as part of the build process, and unified. We no longer have a separate version or history for each project. The -controlling version number is in /VERSION.md and the master history is in /HISTORY.md. +controlling version number is in `/VERSION.md` and the master history is in `/HISTORY.md`. -While there may be multiple versions of HISTORY.md in different branches, the +While there may be multiple versions of `HISTORY.md` in different branches, the **master** branch is source of truth and is the version that is published to the website. -# VERSION.md +## VERSION.md -The version shown in VERSION.md is the upcoming release version. This means: +The version shown in `VERSION.md` is the upcoming release version. This means: 1. A snapshot of the repository will show the changes relevant to that version 2. The build system will simply use that version number when building. - 3. If a release does not exist for the version shown, then you are at the + 3. If a release does not exist for the version shown, then you are at the bleeding edge. -# TIER.md +## TIER.md -The release tier is updated in TIER.md? +The release tier is updated in `TIER.md`? -# How history and version are updated +## How history and version are updated -For Alpha versions (**master**), the version number is incremented at the end of a -successful Nightly build. This means that during a single day, there may be multiple +For Alpha versions (**master**), the version number is incremented at the end of a +successful Nightly build. This means that during a single day, there may be multiple builds with the same version number. Only the last one of these is kept. A similar process will be followed for Beta versions. -For Stable versions, the version number should be manually incremented in a pull +For Stable versions, the version number should be manually incremented in a pull request (these are much rarer). -## History format +### History format -``` -## +```text +## [([/])]: [(#)] ``` For example: -``` +```text ## 2020-01-27 13.0.65 beta feat(developer/compiler): Hotkeys defined in .kmn no longer need to be quoted (#2432) chore: Release beta (#2555)