all: Switch to new preview build versioning scheme.

See https://github.com/micropython/micropython/issues/12127 for details.

Previously at the point when a release is made, we update mpconfig.h
and set a git tag. i.e. the version increments at the release.

Now the version increments immediately after the release. The workflow is:
1. Final commit in the cycle updates mpconfig.h to set (X, Y, 0, 0) (i.e.
   clear the pre-release state).
2. This commit is tagged "vX.Y.0".
3. First commit for the new cycle updates mpconfig.h to set (X, Y+1, 0, 1)
   (i.e. increment the minor version, set the pre-release state).
4. This commit is tagged "vX.Y+1.0-preview".

The idea is that a nightly build is actually a "preview" of the _next_
release. i.e. any documentation describing the current release may not
actually match the nightly build. So we use "preview" as our semver
pre-release identifier.

Changes in this commit:
 - Add MICROPY_VERSION_PRERELEASE to mpconfig.h to allow indicating that
   this is not a release version.
 - Remove unused MICROPY_VERSION integer.
 - Append "-preview" to MICROPY_VERSION_STRING when the pre-release state
   is set.
 - Update py/makeversionhdr.py to no longer generate MICROPY_GIT_HASH.
 - Remove the one place MICROPY_GIT_HASH was used (it can use
   MICROPY_GIT_TAG instead).
 - Update py/makeversionhdr.py to also understand
   MICROPY_VERSION_PRERELEASE in mpconfig.h.
 - Update py/makeversionhdr.py to convert the git-describe output into
   semver-compatible "X.Y.Z-preview.N.gHASH".
 - Update autobuild.sh to generate filenames using the new scheme.
 - Update remove_old_firmware.py to match new scheme.
 - Update mpremote's pyproject.toml to handle the "-preview" suffix in the
   tag. setuptools_scm maps to this "rc0" to match PEP440.
 - Fix docs heading where it incorrectly said "vvX.Y.Z" for release docs.

This work was funded through GitHub Sponsors.

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>

tools/autobuild/autobuild.sh

@@ -54,9 +54,19 @@ pushd ${MICROPY_AUTOBUILD_MICROPYTHON_REPO}
 make -C mpy-cross
 
 # make the firmware tag
+# final filename will be <BOARD><-VARIANT>-<DATE>-v<SEMVER>.ext
+# where SEMVER is vX.Y.Z or vX.Y.Z-preview.N.gHASH or vX.Y.Z-preview.N.gHASH.dirty
 FW_DATE=$(date '+%Y%m%d')
-FW_GIT="$(git describe --dirty || echo unknown)"
-FW_TAG="-$FW_DATE-unstable-$FW_GIT"
+# same logic as makeversionhdr.py, convert git-describe output into semver-compatible
+FW_GIT_TAG="$(git describe --tags --dirty --always --match 'v[1-9].*')"
+FW_SEMVER_MAJOR_MINOR_PATCH="$(echo $FW_GIT_TAG | cut -d'-' -f1)"
+FW_SEMVER_PRERELEASE="$(echo $FW_GIT_TAG | cut -s -d'-' -f2-)"
+if [ -z "$FW_SEMVER_PRERELEASE" ]; then
+    FW_SEMVER="$FW_SEMVER_MAJOR_MINOR_PATCH"
+else
+    FW_SEMVER="$FW_SEMVER_MAJOR_MINOR_PATCH-$(echo $FW_SEMVER_PRERELEASE | tr - .)"
+fi
+FW_TAG="-$FW_DATE-$FW_SEMVER"
 
 # build new firmware
 cd ports/cc3200

tools/autobuild/remove_old_firmware.py

@@ -14,7 +14,7 @@ def main():
 
     # SSH to get list of existing files.
     p = subprocess.run(
-        ["ssh", ssh_machine, "find", ssh_firmware_dir, "-name", "\\*-unstable-v\\*"],
+        ["ssh", ssh_machine, "find", ssh_firmware_dir, "-name", "\\*-preview.\\*"],
         capture_output=True,
     )
     if p.returncode != 0:
@@ -26,31 +26,33 @@ def main():
     boards = {}
     for file in all_files:
         m = re.match(
-            rb"([a-z/.]+)/([A-Za-z0-9_-]+)-(20[0-9]{6})-unstable-(v[0-9.-]+-g[0-9a-f]+).",
+            rb"([a-z/.]+)/([A-Za-z0-9_-]+)-(20[0-9]{6})-(v[0-9.]+)-preview.([0-9]+).g[0-9a-f]+.",
             file,
         )
         if not m:
             continue
-        dir, board, date, version = m.groups()
+        dir, board, date, version, ncommits = m.groups()
         if board not in boards:
             boards[board] = {}
-        if (date, version) not in boards[board]:
-            boards[board][(date, version)] = []
-        boards[board][(date, version)].append(file)
+        if (date, version, ncommits) not in boards[board]:
+            boards[board][(date, version, ncommits)] = []
+        boards[board][(date, version, ncommits)].append(file)
 
     # Collect files to remove based on date and version.
     remove = []
     for board in boards.values():
-        filelist = [(date, version, files) for (date, version), files in board.items()]
+        filelist = [
+            (date, version, ncommits, files) for (date, version, ncommits), files in board.items()
+        ]
         filelist.sort(reverse=True)
         keep = []
-        for date, version, files in filelist:
-            if keep and version == keep[-1]:
+        for date, version, ncommits, files in filelist:
+            if keep and (version, ncommits) == keep[-1]:
                 remove.extend(files)
             elif len(keep) >= NUM_KEEP_PER_BOARD:
                 remove.extend(files)
             else:
-                keep.append(version)
+                keep.append((version, ncommits))
 
     if DEBUG:
         all_files.sort(reverse=True)

tools/mpremote/pyproject.toml

@@ -36,9 +36,14 @@ mpremote = "mpremote.main:main"
 [tool.hatch.metadata.hooks.requirements_txt]
 files = ["requirements.txt"]
 
+# This will be PEP-440 normalised into either:
+# mpremote-X.Y.Z (on vX.Y.Z release tag)
+# mpremote-X.Y.Zrc0 (on vX.Y.Z-preview tag, i.e. first commit in the cycle)
+# mpremote-X.Y.Zrc0.postN+gHASH (N commits past vX.Y.Z-preview tag)
+# mpremote-X.Y.Zrc0.postN+gHASH.dDATE (N commits past vX.Y.Z-preview tag, dirty)
 [tool.hatch.version]
 source = "vcs"
-tag-pattern = "(?P<version>v(\\d+).(\\d+).(\\d+))"
+tag-pattern = "(?P<version>v(\\d+).(\\d+).(\\d+)(-preview)?)"
 raw-options = { root = "../..", version_scheme = "post-release" }
 
 [tool.hatch.build]