project8 / dripline-python

python implementation of project8/dripline
Other
2 stars 0 forks source link

tagging format inconsistent with RTD #26

Open laroque opened 6 years ago

laroque commented 6 years ago

Problem

RTD has an automatic label for what it considers to be the "stable" version of a package. This is based on some logical sort/parsing of tags. Our convention of wpX1.Y1.Z1_pythonX2.Y2.Z2 is not recognized and the build always goes for the existing v3.1.0 rather than wp2.1.1_python3.6.0.

Suggestions

We have several options (note that here [X,Y,Z] are the [Major,Minor,Patch] version numbers, and 1 indicates values for the wire-protocol, while 2 denotes values for this repo):

  1. (currently implemented) Disable "stable" and enable building HEAD of the master branch and use that as the default rather than stable. Advantage: is already configured and working. Disadvantage: is not parallel to the rest of our repos which are able to use stable.
  2. Change the convention to vX2.Y2.Z2_wpX1.Y1.Z1 (may want a - rather than a _ between the two. Advantage: would likely result in correct "stable" builds (requires testing), making things more parallel; retains both package and WP version information (if this is the correct place for that). Disadvantage: requires testing to ensure desired behavior achieved; assumes we still want WP version in tags.
  3. Change the convention to vX2.Y2.Z2. Advantage: Would work as expected on RTD; would fully parallel our other repos. Disadvantage: Does not have WP information in the version string (again, do we want that?).

Notes

wcpettus commented 6 years ago

I like convention 3