1 Semantic Versioning Policy
Andrew Gallagher edited this page 2025-02-06 10:06:12 +00:00

(Work in progress)

The following semantic version policy is proposed for future hockeypuck releases:

  • Patch version increments

    • MUST be upgradable in-place without operational disruption
    • MUST NOT make changes to the SKS or HKP protocols
    • MAY make minor cosmetic breaking changes to e.g. custom templates
  • Minor version increments

    • MUST be upgradable in-place, however disruption (such as rebuilding) is permitted
    • MAY make breaking changes to SKS sync, including data normalisation
    • MAY make non-breaking changes to HKP
  • Major version increments

    • Major refactoring of the codebase, disruptive or otherwise
    • Any changes not covered by the above