prjemian / spec2nexus

Converts SPEC data files and scans into NeXus HDF5 files
https://prjemian.github.io/spec2nexus/
4 stars 7 forks source link

switch to semantic versioning #135

Closed prjemian closed 5 years ago

prjemian commented 5 years ago

Following apstools, spec2nexus would benefit by switching to use of semantic versioning rather than its current scheme of calendar-based versioning.

Note:

What to do with existing tags?

There are too many calendar-based releases and tags to remove them from GitHub. Leave them. They will be a nuisance and a constant reminder about this.

How to update?

Even if the 2019. releases and conda packages are removed, it may still be necessary to uninstall and reinstall spec2nexus* to effect an update:

  1. conda uninstall -y spec2nexus
  2. conda install -c prjemian "spec2nexus< 2000"

What will be the next version number?

Accepting that the CalVer releases started (effectively) the 1.0 series. The change in scan numbering (due to multiple, identical scan numbers in a single file) was API-breaking, thus began the (effectively) 2.0 series. This change in versioning scheme does not break the current API, so the next version will be 2.1.0.

prjemian commented 5 years ago

The only work to be done here is to use semver during the next release process. Renaming the milestone was the first step.

prjemian commented 5 years ago

released