Skip to content

Gem Versioning Rules

Michael Telford edited this page Jun 4, 2020 · 1 revision

The wgit gem follows these semantic versioning rules:

  • The version format is MAJOR.MINOR.PATCH e.g. 0.1.0.
  • Since the gem hasn't reached v1.0.0 yet, slightly different semantic versioning rules apply.
  • The PATCH represents non breaking changes while the MINOR represents breaking changes e.g. updating from version 0.1.0 to 0.2.0 will likely introduce breaking changes necessitating updates to your codebase.
  • To determine what changes are needed, consult the CHANGELOG.md. If you need help, raise an issue.
  • Once wgit v1.0.0 is released, normal semantic versioning rules will apply e.g. only a MAJOR version change should introduce breaking changes.

The above rules are standard semantic versioning. To conclude, because MAJOR is < 1, you should expect breaking changes on any MINOR update, but not PATCH updates. All changes are recorded in the CHANGELOG - consult it before upgrading your version of Wgit.