Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 2.39 KB

VERSIONING.rst

File metadata and controls

68 lines (47 loc) · 2.39 KB
Raw

Versioning information for libvirt-go-xml-module

Release schedule

The XML manipulation library follows the same release schedule as the main C library, with new releases of both usually being tagged at the same time.

Versioning scheme

Despite the release schedule being the same, the XML manipulation library do not follow the same versioning scheme as the main C library.

The XML manipulation library has adopted semantic versioning, which is both expected in the Go ecosystem and extremly important in order to work correctly within the Go module system.

When it's time to tag a new release, the logic described below is followed: in this example, we will assume that the most recent release of the XML manipulation library is v0.7005.0 (made along libvirt 7.5.0) and that libvirt 7.6.0 has just been tagged.

  • if libvirt 7.6.0 introduces changes to the XML schema
    • make sure the XML manipulation library is aware of them and tag the result as v0.7006.0
  • if libvirt 7.6.0 doesn't introduce changes to the XML schema
    • if there have been other tweaks and changes to the XML manipulation library since v0.7005.0
      • tag the current code as v0.7005.1
    • if the XML manipulation library is completely unchanged from v0.7005.0
      • do nothing

This versioning scheme has the following desirable properties:

  • it complies with the semantic versioning specification;
  • it contains an encoded version of the libvirt XML schema it implements, making it easy to tell at a glance whether or not the libvirt functionality you're interested in will be available to your Go application;
  • it removes the need for users to update their import paths once per year even though the XML manipulation library has retained complete backwards compatibility;
  • it avoids the situation where a new version of the XML manipulation library is tagged even though it contains no actual changes, as well as the opposite scenario where fixes made to the XML manipulation library cannot make it into a release until the C library introduces a new XML element or attribute.