f11ef4cc4e
Recently(?) github started making it the default to only copy a single branch (e.g., main) and NO TAGS into new forks. This makes the step of the build process that determines the CircuitPython version not work, because tags are expected to be present. When tags are not present, the version number is only a git hash. The version number ends up being 0.0.0. This causes problems with libraries that check for CircuitPython version to determine compatibility, among other things. We'll do other things to improve the situation, such as document it. But it'd also be good if the build stopped when this detectable condition occurs.
127 lines
3.7 KiB
Python
127 lines
3.7 KiB
Python
"""
|
|
Generate header file with macros defining MicroPython version info.
|
|
|
|
This script works with Python 3.7 and newer
|
|
"""
|
|
|
|
from __future__ import print_function
|
|
|
|
import sys
|
|
import os
|
|
import pathlib
|
|
import datetime
|
|
import subprocess
|
|
|
|
tools_describe = str(pathlib.Path(__file__).parent.parent / "tools/describe")
|
|
|
|
|
|
def get_version_info_from_git():
|
|
# Note: git describe doesn't work if no tag is available
|
|
try:
|
|
git_tag = subprocess.check_output(
|
|
[tools_describe], stderr=subprocess.STDOUT, universal_newlines=True, shell=True
|
|
).strip()
|
|
except subprocess.CalledProcessError as er:
|
|
if er.returncode == 128:
|
|
# git exit code of 128 means no repository found
|
|
return None
|
|
git_tag = ""
|
|
except OSError as e:
|
|
return None
|
|
try:
|
|
git_hash = subprocess.check_output(
|
|
["git", "rev-parse", "--short", "HEAD"],
|
|
stderr=subprocess.STDOUT,
|
|
universal_newlines=True,
|
|
).strip()
|
|
except subprocess.CalledProcessError:
|
|
git_hash = "unknown"
|
|
except OSError:
|
|
return None
|
|
|
|
try:
|
|
# Check if there are any modified files.
|
|
subprocess.check_call(
|
|
["git", "diff", "--no-ext-diff", "--quiet", "--exit-code"], stderr=subprocess.STDOUT
|
|
)
|
|
# Check if there are any staged files.
|
|
subprocess.check_call(
|
|
["git", "diff-index", "--cached", "--quiet", "HEAD", "--"], stderr=subprocess.STDOUT
|
|
)
|
|
except subprocess.CalledProcessError:
|
|
git_hash += "-dirty"
|
|
except OSError:
|
|
return None
|
|
|
|
# Try to extract MicroPython version from git tag
|
|
ver = git_tag.split("-")[0].split(".")
|
|
|
|
return git_tag, git_hash, ver
|
|
|
|
|
|
def cannot_determine_version():
|
|
raise SystemExit(
|
|
"""Cannot determine version.
|
|
|
|
CircuitPython must be built from a git clone with tags.
|
|
If you cloned from a fork, fetch the tags from adafruit/circuitpython as follows:
|
|
|
|
git fetch --tags --recurse-submodules=no --shallow-since="2021-07-01" https://github.com/adafruit/circuitpython HEAD"""
|
|
)
|
|
|
|
|
|
def make_version_header(filename):
|
|
# Get version info using git (required)
|
|
info = get_version_info_from_git()
|
|
if info is None:
|
|
cannot_determine_version()
|
|
git_tag, git_hash, ver = info
|
|
if len(ver) < 3:
|
|
cannot_determine_version()
|
|
else:
|
|
version_string = ".".join(ver)
|
|
|
|
build_date = datetime.date.today()
|
|
if "SOURCE_DATE_EPOCH" in os.environ:
|
|
build_date = datetime.datetime.utcfromtimestamp(
|
|
int(os.environ["SOURCE_DATE_EPOCH"])
|
|
).date()
|
|
|
|
# Generate the file with the git and version info
|
|
file_data = """\
|
|
// This file was generated by py/makeversionhdr.py
|
|
#define MICROPY_GIT_TAG "%s"
|
|
#define MICROPY_GIT_HASH "%s"
|
|
#define MICROPY_BUILD_DATE "%s"
|
|
#define MICROPY_VERSION_MAJOR (%s)
|
|
#define MICROPY_VERSION_MINOR (%s)
|
|
#define MICROPY_VERSION_MICRO (%s)
|
|
#define MICROPY_VERSION_STRING "%s"
|
|
#define MICROPY_FULL_VERSION_INFO "Adafruit CircuitPython " MICROPY_GIT_TAG " on " MICROPY_BUILD_DATE "; " MICROPY_HW_BOARD_NAME " with " MICROPY_HW_MCU_NAME
|
|
""" % (
|
|
git_tag,
|
|
git_hash,
|
|
datetime.date.today().strftime("%Y-%m-%d"),
|
|
ver[0].replace("v", ""),
|
|
ver[1],
|
|
ver[2],
|
|
version_string,
|
|
)
|
|
|
|
# Check if the file contents changed from last time
|
|
write_file = True
|
|
if os.path.isfile(filename):
|
|
with open(filename, "r") as f:
|
|
existing_data = f.read()
|
|
if existing_data == file_data:
|
|
write_file = False
|
|
|
|
# Only write the file if we need to
|
|
if write_file:
|
|
with open(filename, "w") as f:
|
|
f.write(file_data)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
make_version_header(sys.argv[1])
|