https://github.com/bep/semverpair

A specification and some utility functions for a very simple encoding scheme that combines two semver versions.
https://github.com/bep/semverpair

Last synced: 11 months ago
JSON representation

A specification and some utility functions for a very simple encoding scheme that combines two semver versions.

• Host: GitHub
• URL: https://github.com/bep/semverpair
• Owner: bep
• License: mit
• Created: 2021-10-07T08:31:07.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-13T15:39:49.000Z (over 4 years ago)
• Last Synced: 2025-02-13T14:40:58.038Z (about 1 year ago)
• Language: Go
• Size: 14.6 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

This library speficies a simple **encoding and decoding scheme** to combine **two semver versions** into one.

My intended use for this is as a versioning scheme for Hugo Modules that are wrappers of upstream libraries. The wrapper and library have diverging release cycles, and we want to maintain the upstream version info, so we cannot just use the upstream version as is.

Features:

* The upstream library controls the major version.

* It should be easy to determine the upstream version just by looking at it.

* It should always be possible to programmatially decode back to the originals.

* A minor or patch increment from either of the two versions should result in a version that is _greater than_ the previous version.

The minor and patch version:

* Starts out with one digit (width) telling how many digits each version holds.

* Then each version is printed padded with leading zeros.

Some examples a width of 2 digits per version:

* `v3.0.0 + v3.0.0 = v3.20000.20000`

* `v3.1.0 + v3.0.0" = v3.20100.20000`

* `v3.6.5 + v3.99.99 = v3.20699.20599`

If either of the versions reaches 100, the prefix can be incremented:

* `v3.6.5 + v3.99.100 = v3.20699.3005100`