diff options
author | Jim Mussared <jim.mussared@gmail.com> | 2023-10-04 11:20:47 +1100 |
---|---|---|
committer | Jim Mussared <jim.mussared@gmail.com> | 2023-10-06 12:10:14 +1100 |
commit | 69e34b6b6bdf45bc1111777c46839a8b5fcb30bd (patch) | |
tree | 757623344e1f4a4004234f93d7541c1d9472fdfa /docs/conf.py | |
parent | e00a144008f368df878c12606fdbf651af2a1dc0 (diff) |
all: Switch to new preview build versioning scheme.v1.22.0-preview
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>
Diffstat (limited to 'docs/conf.py')
-rwxr-xr-x | docs/conf.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py index 0dbbfe0f7..49ddd22be 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,10 +21,12 @@ import os # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('.')) -# The members of the html_context dict are available inside topindex.html +# The MICROPY_VERSION env var should be "vX.Y.Z" (or unset). micropy_version = os.getenv('MICROPY_VERSION') or 'latest' micropy_all_versions = (os.getenv('MICROPY_ALL_VERSIONS') or 'latest').split(',') url_pattern = '%s/en/%%s' % (os.getenv('MICROPY_URL_PREFIX') or '/',) + +# The members of the html_context dict are available inside topindex.html html_context = { 'cur_version':micropy_version, 'all_versions':[ |