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>
This commit is contained in:
@@ -26,22 +26,32 @@
|
||||
#ifndef MICROPY_INCLUDED_PY_MPCONFIG_H
|
||||
#define MICROPY_INCLUDED_PY_MPCONFIG_H
|
||||
|
||||
// Current version of MicroPython
|
||||
// Current version of MicroPython. This is used by sys.implementation.version
|
||||
// as well as a fallback to generate MICROPY_GIT_TAG if the git repo or tags
|
||||
// are unavailable.
|
||||
#define MICROPY_VERSION_MAJOR 1
|
||||
#define MICROPY_VERSION_MINOR 21
|
||||
#define MICROPY_VERSION_MINOR 22
|
||||
#define MICROPY_VERSION_MICRO 0
|
||||
#define MICROPY_VERSION_PRERELEASE 1
|
||||
|
||||
// Combined version as a 32-bit number for convenience
|
||||
#define MICROPY_VERSION ( \
|
||||
MICROPY_VERSION_MAJOR << 16 \
|
||||
| MICROPY_VERSION_MINOR << 8 \
|
||||
| MICROPY_VERSION_MICRO)
|
||||
// Combined version as a 32-bit number for convenience to allow version
|
||||
// comparison. Doesn't include prerelease state.
|
||||
// e.g. #if MICROPY_VERSION < MICROPY_MAKE_VERSION(1, 22, 0)
|
||||
#define MICROPY_MAKE_VERSION(major, minor, patch) (major << 16 | minor << 8 | patch)
|
||||
#define MICROPY_VERSION MICROPY_MAKE_VERSION(MICROPY_VERSION_MAJOR, MICROPY_VERSION_MINOR, MICROPY_VERSION_MICRO)
|
||||
|
||||
// String version
|
||||
#define MICROPY_VERSION_STRING \
|
||||
// String version. This is only used directly for platform.platform and
|
||||
// os.uname().release. All other version info available in the firmware (e.g.
|
||||
// the REPL banner) comes from MICROPY_GIT_TAG.
|
||||
#define MICROPY_VERSION_STRING_BASE \
|
||||
MP_STRINGIFY(MICROPY_VERSION_MAJOR) "." \
|
||||
MP_STRINGIFY(MICROPY_VERSION_MINOR) "." \
|
||||
MP_STRINGIFY(MICROPY_VERSION_MICRO)
|
||||
#if MICROPY_VERSION_PRERELEASE
|
||||
#define MICROPY_VERSION_STRING MICROPY_VERSION_STRING_BASE "-preview"
|
||||
#else
|
||||
#define MICROPY_VERSION_STRING MICROPY_VERSION_STRING_BASE
|
||||
#endif
|
||||
|
||||
// This file contains default configuration settings for MicroPython.
|
||||
// You can override any of the options below using mpconfigport.h file
|
||||
|
||||
Reference in New Issue
Block a user