Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.56 KB

BrenthyVersioning.md

File metadata and controls

30 lines (19 loc) · 1.56 KB

the version numbering systems for Brenthy and the brenthy_tools library

Brenthy Versioning

BrenthyAPI Protocol Versioning

The BrenthyAPI protocol defines how the Brenthy Core andbrenthy_api communicate.

The BrenthyAPI protocol version (BAP version) is represented by a single number. Brenthy Core and brenthy_api retain all old BrenthyAPI modules, so a Brenthy instance's or brenthy_api's BAP version is the version of the newest BrenthyAPI protocol which it supports.

Brenthy Core Versioning

Brenthy Core refers to the main Brenthy software which runs blockchains, as opposed to peripheral projects like the brenthy_tools library and its brenthy_api module.

The Brenthy Core version follows the standard three-number major-minor-patch format. The numbers in the version code have the following meaning:

  • major: the newest BrenthyAPI protocol version
  • minor: the number of updates that have introduced new features or significant changes to Brenthy, since the last major update
  • patch: the number of updates that have introduced fixes or small changes to Brenthy, since the last minor update

brenthy_tools Versioning

The brenthy_tools library version also follows the standard three-number major-minor-patch format. The numbers in the version code have the following meaning:

  • major: the newest BrenthyAPI protocol version
  • minor: the number of updates to brenthy_api, but not the BrenthyAPI protocol, since the last major update
  • patch: the number of updates to utilities that didn't directly influence brenthy_api since the last minor update